hetzner-haystack 1.0.0__tar.gz
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.
- hetzner_haystack-1.0.0/.gitignore +146 -0
- hetzner_haystack-1.0.0/LICENSE.txt +201 -0
- hetzner_haystack-1.0.0/PKG-INFO +40 -0
- hetzner_haystack-1.0.0/README.md +15 -0
- hetzner_haystack-1.0.0/pydoc/config_docusaurus.yml +13 -0
- hetzner_haystack-1.0.0/pyproject.toml +162 -0
- hetzner_haystack-1.0.0/src/haystack_integrations/components/generators/hetzner/__init__.py +7 -0
- hetzner_haystack-1.0.0/src/haystack_integrations/components/generators/hetzner/chat/__init__.py +7 -0
- hetzner_haystack-1.0.0/src/haystack_integrations/components/generators/hetzner/chat/chat_generator.py +179 -0
- hetzner_haystack-1.0.0/src/haystack_integrations/components/generators/py.typed +0 -0
- hetzner_haystack-1.0.0/tests/__init__.py +3 -0
- hetzner_haystack-1.0.0/tests/conftest.py +44 -0
- hetzner_haystack-1.0.0/tests/test_hetzner_chat_generator.py +278 -0
- hetzner_haystack-1.0.0/tests/test_hetzner_chat_generator_async.py +99 -0
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
pip-wheel-metadata/
|
|
24
|
+
share/python-wheels/
|
|
25
|
+
*.egg-info/
|
|
26
|
+
.installed.cfg
|
|
27
|
+
*.egg
|
|
28
|
+
MANIFEST
|
|
29
|
+
|
|
30
|
+
# PyInstaller
|
|
31
|
+
# Usually these files are written by a python script from a template
|
|
32
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
33
|
+
*.manifest
|
|
34
|
+
*.spec
|
|
35
|
+
|
|
36
|
+
# Installer logs
|
|
37
|
+
pip-log.txt
|
|
38
|
+
pip-delete-this-directory.txt
|
|
39
|
+
|
|
40
|
+
# Unit test / coverage reports
|
|
41
|
+
htmlcov/
|
|
42
|
+
.tox/
|
|
43
|
+
.nox/
|
|
44
|
+
.coverage
|
|
45
|
+
.coverage.*
|
|
46
|
+
.cache
|
|
47
|
+
nosetests.xml
|
|
48
|
+
coverage.xml
|
|
49
|
+
*.cover
|
|
50
|
+
*.py,cover
|
|
51
|
+
.hypothesis/
|
|
52
|
+
.pytest_cache/
|
|
53
|
+
volumes/
|
|
54
|
+
|
|
55
|
+
# Translations
|
|
56
|
+
*.mo
|
|
57
|
+
*.pot
|
|
58
|
+
|
|
59
|
+
# Django stuff:
|
|
60
|
+
*.log
|
|
61
|
+
local_settings.py
|
|
62
|
+
db.sqlite3
|
|
63
|
+
db.sqlite3-journal
|
|
64
|
+
|
|
65
|
+
# Flask stuff:
|
|
66
|
+
instance/
|
|
67
|
+
.webassets-cache
|
|
68
|
+
|
|
69
|
+
# Scrapy stuff:
|
|
70
|
+
.scrapy
|
|
71
|
+
|
|
72
|
+
# Sphinx documentation
|
|
73
|
+
docs/_build/
|
|
74
|
+
|
|
75
|
+
# PyBuilder
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
.python-version
|
|
87
|
+
|
|
88
|
+
# pipenv
|
|
89
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
90
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
91
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
92
|
+
# install all needed dependencies.
|
|
93
|
+
#Pipfile.lock
|
|
94
|
+
|
|
95
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
|
|
96
|
+
__pypackages__/
|
|
97
|
+
|
|
98
|
+
# Celery stuff
|
|
99
|
+
celerybeat-schedule
|
|
100
|
+
celerybeat.pid
|
|
101
|
+
|
|
102
|
+
# SageMath parsed files
|
|
103
|
+
*.sage.py
|
|
104
|
+
|
|
105
|
+
# Environments
|
|
106
|
+
.env
|
|
107
|
+
.venv
|
|
108
|
+
env/
|
|
109
|
+
venv/
|
|
110
|
+
ENV/
|
|
111
|
+
env.bak/
|
|
112
|
+
venv.bak/
|
|
113
|
+
|
|
114
|
+
# Spyder project settings
|
|
115
|
+
.spyderproject
|
|
116
|
+
.spyproject
|
|
117
|
+
|
|
118
|
+
# Rope project settings
|
|
119
|
+
.ropeproject
|
|
120
|
+
|
|
121
|
+
# mkdocs documentation
|
|
122
|
+
/site
|
|
123
|
+
|
|
124
|
+
# mypy
|
|
125
|
+
.mypy_cache/
|
|
126
|
+
.dmypy.json
|
|
127
|
+
dmypy.json
|
|
128
|
+
|
|
129
|
+
# Pyre type checker
|
|
130
|
+
.pyre/
|
|
131
|
+
|
|
132
|
+
# IDEs
|
|
133
|
+
.vscode
|
|
134
|
+
|
|
135
|
+
# Docs generation artifacts
|
|
136
|
+
_readme_*.md
|
|
137
|
+
.idea
|
|
138
|
+
|
|
139
|
+
# macOS
|
|
140
|
+
.DS_Store
|
|
141
|
+
|
|
142
|
+
# http cache (requests-cache)
|
|
143
|
+
**/http_cache.sqlite
|
|
144
|
+
|
|
145
|
+
# ruff
|
|
146
|
+
.ruff_cache
|
|
@@ -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.
|
|
@@ -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
|
+
[](https://pypi.org/project/hetzner-haystack)
|
|
29
|
+
[](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,15 @@
|
|
|
1
|
+
# hetzner-haystack
|
|
2
|
+
|
|
3
|
+
[](https://pypi.org/project/hetzner-haystack)
|
|
4
|
+
[](https://pypi.org/project/hetzner-haystack)
|
|
5
|
+
|
|
6
|
+
- [Integration page](https://haystack.deepset.ai/integrations/hetzner)
|
|
7
|
+
- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/hetzner/CHANGELOG.md)
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Contributing
|
|
12
|
+
|
|
13
|
+
Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).
|
|
14
|
+
|
|
15
|
+
To run integration tests locally, you need to export the `HETZNER_API_KEY` environment variable.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
loaders:
|
|
2
|
+
- modules:
|
|
3
|
+
- haystack_integrations.components.generators.hetzner.chat.chat_generator
|
|
4
|
+
search_path: [../src]
|
|
5
|
+
processors:
|
|
6
|
+
- type: filter
|
|
7
|
+
documented_only: true
|
|
8
|
+
skip_empty_modules: true
|
|
9
|
+
renderer:
|
|
10
|
+
description: Hetzner integration for Haystack
|
|
11
|
+
id: integrations-hetzner
|
|
12
|
+
filename: hetzner.md
|
|
13
|
+
title: Hetzner
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling", "hatch-vcs"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "hetzner-haystack"
|
|
7
|
+
dynamic = ["version"]
|
|
8
|
+
description = 'An integration between the Hetzner Inference API and Haystack'
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
|
+
license = "Apache-2.0"
|
|
12
|
+
keywords = ["haystack", "hetzner", "inference", "llm", "chat generator", "qwen"]
|
|
13
|
+
authors = [{ name = "deepset GmbH", email = "info@deepset.ai" }]
|
|
14
|
+
classifiers = [
|
|
15
|
+
"License :: OSI Approved :: Apache Software License",
|
|
16
|
+
"Development Status :: 4 - Beta",
|
|
17
|
+
"Programming Language :: Python",
|
|
18
|
+
"Programming Language :: Python :: 3.10",
|
|
19
|
+
"Programming Language :: Python :: 3.11",
|
|
20
|
+
"Programming Language :: Python :: 3.12",
|
|
21
|
+
"Programming Language :: Python :: 3.13",
|
|
22
|
+
"Programming Language :: Python :: 3.14",
|
|
23
|
+
"Programming Language :: Python :: Implementation :: CPython",
|
|
24
|
+
"Programming Language :: Python :: Implementation :: PyPy",
|
|
25
|
+
]
|
|
26
|
+
dependencies = ["haystack-ai>=2.22.0"]
|
|
27
|
+
|
|
28
|
+
[project.urls]
|
|
29
|
+
Documentation = "https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/hetzner#readme"
|
|
30
|
+
Issues = "https://github.com/deepset-ai/haystack-core-integrations/issues"
|
|
31
|
+
Source = "https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/hetzner"
|
|
32
|
+
|
|
33
|
+
[tool.hatch.build.targets.wheel]
|
|
34
|
+
packages = ["src/haystack_integrations"]
|
|
35
|
+
|
|
36
|
+
[tool.hatch.version]
|
|
37
|
+
source = "vcs"
|
|
38
|
+
tag-pattern = 'integrations\/hetzner-v(?P<version>.*)'
|
|
39
|
+
|
|
40
|
+
[tool.hatch.version.raw-options]
|
|
41
|
+
root = "../.."
|
|
42
|
+
git_describe_command = 'git describe --tags --match="integrations/hetzner-v[0-9]*"'
|
|
43
|
+
|
|
44
|
+
[tool.hatch.envs.default]
|
|
45
|
+
installer = "uv"
|
|
46
|
+
dependencies = ["haystack-pydoc-tools", "ruff"]
|
|
47
|
+
|
|
48
|
+
[tool.hatch.envs.default.scripts]
|
|
49
|
+
docs = ["haystack-pydoc pydoc/config_docusaurus.yml"]
|
|
50
|
+
fmt = "ruff check --fix {args}; ruff format {args}"
|
|
51
|
+
fmt-check = "ruff check {args} && ruff format --check {args}"
|
|
52
|
+
|
|
53
|
+
[tool.hatch.envs.test]
|
|
54
|
+
dependencies = [
|
|
55
|
+
"pytest",
|
|
56
|
+
"pytest-asyncio",
|
|
57
|
+
"pytest-cov",
|
|
58
|
+
"pytest-rerunfailures",
|
|
59
|
+
"mypy",
|
|
60
|
+
"pip",
|
|
61
|
+
]
|
|
62
|
+
|
|
63
|
+
[tool.hatch.envs.test.scripts]
|
|
64
|
+
unit = 'pytest -m "not integration" {args:tests}'
|
|
65
|
+
integration = 'pytest -m "integration" {args:tests}'
|
|
66
|
+
all = 'pytest {args:tests}'
|
|
67
|
+
unit-cov-retry = 'pytest --cov=haystack_integrations --reruns 3 --reruns-delay 30 -x -m "not integration" {args:tests}'
|
|
68
|
+
integration-cov-append-retry = 'pytest --cov=haystack_integrations --cov-append --reruns 3 --reruns-delay 30 -x -m "integration" {args:tests}'
|
|
69
|
+
types = "mypy -p haystack_integrations.components.generators.hetzner {args}"
|
|
70
|
+
|
|
71
|
+
[tool.mypy]
|
|
72
|
+
install_types = true
|
|
73
|
+
non_interactive = true
|
|
74
|
+
check_untyped_defs = true
|
|
75
|
+
disallow_incomplete_defs = true
|
|
76
|
+
|
|
77
|
+
[tool.ruff]
|
|
78
|
+
line-length = 120
|
|
79
|
+
|
|
80
|
+
[tool.ruff.lint]
|
|
81
|
+
select = [
|
|
82
|
+
"A",
|
|
83
|
+
"ANN",
|
|
84
|
+
"ARG",
|
|
85
|
+
"B",
|
|
86
|
+
"C",
|
|
87
|
+
"D102", # Missing docstring in public method
|
|
88
|
+
"D103", # Missing docstring in public function
|
|
89
|
+
"D205", # 1 blank line required between summary line and description
|
|
90
|
+
"D209", # Closing triple quotes go to new line
|
|
91
|
+
"D213", # summary lines must be positioned on the second physical line of the docstring
|
|
92
|
+
"D417", # Missing argument descriptions in the docstring
|
|
93
|
+
"D419", # Docstring is empty
|
|
94
|
+
"DTZ",
|
|
95
|
+
"E",
|
|
96
|
+
"EM",
|
|
97
|
+
"F",
|
|
98
|
+
"I",
|
|
99
|
+
"ICN",
|
|
100
|
+
"ISC",
|
|
101
|
+
"N",
|
|
102
|
+
"PLC",
|
|
103
|
+
"PLE",
|
|
104
|
+
"PLR",
|
|
105
|
+
"PLW",
|
|
106
|
+
"Q",
|
|
107
|
+
"RUF",
|
|
108
|
+
"S",
|
|
109
|
+
"T",
|
|
110
|
+
"TID",
|
|
111
|
+
"UP",
|
|
112
|
+
"W",
|
|
113
|
+
"YTT",
|
|
114
|
+
]
|
|
115
|
+
ignore = [
|
|
116
|
+
# Allow non-abstract empty methods in abstract base classes
|
|
117
|
+
"B027",
|
|
118
|
+
# Allow function calls in argument defaults (common Haystack pattern for Secret.from_env_var)
|
|
119
|
+
"B008",
|
|
120
|
+
# Ignore checks for possible passwords
|
|
121
|
+
"S105",
|
|
122
|
+
"S106",
|
|
123
|
+
"S107",
|
|
124
|
+
# Ignore complexity
|
|
125
|
+
"C901",
|
|
126
|
+
"PLR0911",
|
|
127
|
+
"PLR0912",
|
|
128
|
+
"PLR0913",
|
|
129
|
+
"PLR0915",
|
|
130
|
+
"PLR0917",
|
|
131
|
+
# Allow `Any` type - used legitimately for dynamic types and SDK boundaries
|
|
132
|
+
"ANN401",
|
|
133
|
+
]
|
|
134
|
+
|
|
135
|
+
[tool.ruff.lint.isort]
|
|
136
|
+
known-first-party = ["haystack_integrations"]
|
|
137
|
+
|
|
138
|
+
[tool.ruff.lint.flake8-tidy-imports]
|
|
139
|
+
ban-relative-imports = "parents"
|
|
140
|
+
|
|
141
|
+
[tool.ruff.lint.per-file-ignores]
|
|
142
|
+
# Tests can use magic values, assertions, relative imports, and don't need type annotations
|
|
143
|
+
"tests/**/*" = ["PLR2004", "S101", "TID252", "D", "ANN"]
|
|
144
|
+
|
|
145
|
+
[tool.coverage.run]
|
|
146
|
+
source = ["haystack_integrations"]
|
|
147
|
+
branch = true
|
|
148
|
+
parallel = false
|
|
149
|
+
relative_files = true
|
|
150
|
+
|
|
151
|
+
[tool.coverage.report]
|
|
152
|
+
omit = ["*/tests/*", "*/__init__.py"]
|
|
153
|
+
show_missing = true
|
|
154
|
+
exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"]
|
|
155
|
+
|
|
156
|
+
[tool.pytest.ini_options]
|
|
157
|
+
addopts = "--strict-markers"
|
|
158
|
+
markers = [
|
|
159
|
+
"integration: integration tests",
|
|
160
|
+
]
|
|
161
|
+
log_cli = true
|
|
162
|
+
asyncio_default_fixture_loop_scope = "function"
|
|
@@ -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,44 @@
|
|
|
1
|
+
# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
|
|
2
|
+
#
|
|
3
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
4
|
+
|
|
5
|
+
import pytest
|
|
6
|
+
from haystack.dataclasses import ChatMessage
|
|
7
|
+
from haystack.tools import Tool
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
@pytest.fixture(autouse=True)
|
|
11
|
+
def allow_deserialization_of_test_modules(monkeypatch):
|
|
12
|
+
"""
|
|
13
|
+
haystack-ai >= 3.0 refuses to deserialize classes and callables from modules outside its
|
|
14
|
+
trusted-module allowlist. Tools and callbacks defined in the test modules live outside that
|
|
15
|
+
allowlist, so trust them explicitly; haystack-ai 2.x ignores this environment variable.
|
|
16
|
+
"""
|
|
17
|
+
monkeypatch.setenv("HAYSTACK_DESERIALIZATION_ALLOWLIST", "tests,test_*")
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
def weather(city: str):
|
|
21
|
+
"""Get weather for a given city."""
|
|
22
|
+
return f"The weather in {city} is sunny and 32°C"
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
def _city_tool(name: str, function):
|
|
26
|
+
return Tool(
|
|
27
|
+
name=name,
|
|
28
|
+
description=f"useful to determine the {name} of a given location",
|
|
29
|
+
parameters={"type": "object", "properties": {"city": {"type": "string"}}, "required": ["city"]},
|
|
30
|
+
function=function,
|
|
31
|
+
)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
@pytest.fixture
|
|
35
|
+
def tools():
|
|
36
|
+
return [_city_tool("weather", weather)]
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
@pytest.fixture
|
|
40
|
+
def chat_messages():
|
|
41
|
+
return [
|
|
42
|
+
ChatMessage.from_system("You are a helpful assistant"),
|
|
43
|
+
ChatMessage.from_user("What's the capital of France"),
|
|
44
|
+
]
|
|
@@ -0,0 +1,278 @@
|
|
|
1
|
+
# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
|
|
2
|
+
#
|
|
3
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
4
|
+
|
|
5
|
+
import json
|
|
6
|
+
import os
|
|
7
|
+
from unittest.mock import patch
|
|
8
|
+
|
|
9
|
+
import pytest
|
|
10
|
+
from haystack import Pipeline
|
|
11
|
+
from haystack.components.generators.utils import print_streaming_chunk
|
|
12
|
+
from haystack.dataclasses import ChatMessage, ChatRole, ImageContent, StreamingChunk
|
|
13
|
+
from haystack.utils.auth import Secret
|
|
14
|
+
from openai.types.chat import ChatCompletion, ChatCompletionMessage
|
|
15
|
+
from openai.types.chat.chat_completion import Choice
|
|
16
|
+
from openai.types.completion_usage import CompletionUsage
|
|
17
|
+
from pydantic import BaseModel
|
|
18
|
+
|
|
19
|
+
from haystack_integrations.components.generators.hetzner.chat.chat_generator import HetznerChatGenerator
|
|
20
|
+
|
|
21
|
+
DEFAULT_MODEL = "Qwen/Qwen3.6-35B-A3B-FP8"
|
|
22
|
+
DEFAULT_API_BASE_URL = "https://inference.hetzner.com/api/v1"
|
|
23
|
+
COMPONENT_TYPE = "haystack_integrations.components.generators.hetzner.chat.chat_generator.HetznerChatGenerator"
|
|
24
|
+
|
|
25
|
+
requires_api_key = pytest.mark.skipif(
|
|
26
|
+
not os.environ.get("HETZNER_API_KEY", None),
|
|
27
|
+
reason="Export an env var called HETZNER_API_KEY containing the Hetzner API token to run this test.",
|
|
28
|
+
)
|
|
29
|
+
|
|
30
|
+
# an 8x8 red PNG, small enough to inline and enough to exercise the multimodal request path
|
|
31
|
+
RED_SQUARE_PNG = "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAICAIAAABLbSncAAAAEUlEQVR42mO4o6GBFTEMLQkAe3tLAYZNzu4AAAAASUVORK5CYII="
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
class CalendarEvent(BaseModel):
|
|
35
|
+
event_name: str
|
|
36
|
+
event_date: str
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
@pytest.fixture
|
|
40
|
+
def mock_chat_completion():
|
|
41
|
+
"""Mock the Hetzner (OpenAI-compatible) chat completion response and reuse it for tests."""
|
|
42
|
+
with patch("openai.resources.chat.completions.Completions.create") as mock_chat_completion_create:
|
|
43
|
+
mock_chat_completion_create.return_value = ChatCompletion(
|
|
44
|
+
id="foo",
|
|
45
|
+
model=DEFAULT_MODEL,
|
|
46
|
+
object="chat.completion",
|
|
47
|
+
choices=[
|
|
48
|
+
Choice(
|
|
49
|
+
finish_reason="stop",
|
|
50
|
+
logprobs=None,
|
|
51
|
+
index=0,
|
|
52
|
+
message=ChatCompletionMessage(content="Hello world!", role="assistant"),
|
|
53
|
+
)
|
|
54
|
+
],
|
|
55
|
+
created=1750162525,
|
|
56
|
+
usage=CompletionUsage(prompt_tokens=57, completion_tokens=40, total_tokens=97),
|
|
57
|
+
)
|
|
58
|
+
yield mock_chat_completion_create
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
class TestHetznerChatGenerator:
|
|
62
|
+
def test_init_default(self, monkeypatch):
|
|
63
|
+
monkeypatch.setenv("HETZNER_API_KEY", "test-api-key")
|
|
64
|
+
component = HetznerChatGenerator()
|
|
65
|
+
assert component.api_key.resolve_value() == "test-api-key"
|
|
66
|
+
assert component.model == DEFAULT_MODEL
|
|
67
|
+
assert component.api_base_url == DEFAULT_API_BASE_URL
|
|
68
|
+
assert component.streaming_callback is None
|
|
69
|
+
assert not component.generation_kwargs
|
|
70
|
+
|
|
71
|
+
def test_init_with_unsupported_model_warns(self, caplog, monkeypatch):
|
|
72
|
+
monkeypatch.setenv("HETZNER_API_KEY", "test-api-key")
|
|
73
|
+
component = HetznerChatGenerator(model="some-model-not-served-by-hetzner")
|
|
74
|
+
# unknown models are passed on to the API, the user is only warned
|
|
75
|
+
assert component.model == "some-model-not-served-by-hetzner"
|
|
76
|
+
assert "not in the list of models known to be served by the Hetzner Inference API" in caplog.text
|
|
77
|
+
|
|
78
|
+
def test_to_dict_default(self, monkeypatch):
|
|
79
|
+
monkeypatch.setenv("HETZNER_API_KEY", "test-api-key")
|
|
80
|
+
data = HetznerChatGenerator().to_dict()
|
|
81
|
+
|
|
82
|
+
assert data["type"] == COMPONENT_TYPE
|
|
83
|
+
assert data["init_parameters"] == {
|
|
84
|
+
"api_key": {"env_vars": ["HETZNER_API_KEY"], "strict": True, "type": "env_var"},
|
|
85
|
+
"model": DEFAULT_MODEL,
|
|
86
|
+
"streaming_callback": None,
|
|
87
|
+
"api_base_url": DEFAULT_API_BASE_URL,
|
|
88
|
+
"generation_kwargs": {},
|
|
89
|
+
"timeout": None,
|
|
90
|
+
"max_retries": None,
|
|
91
|
+
"tools": None,
|
|
92
|
+
"http_client_kwargs": None,
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
def test_to_dict_with_parameters(self, monkeypatch):
|
|
96
|
+
monkeypatch.setenv("ENV_VAR", "test-api-key")
|
|
97
|
+
component = HetznerChatGenerator(
|
|
98
|
+
api_key=Secret.from_env_var("ENV_VAR"),
|
|
99
|
+
model="Qwen3.8-27B",
|
|
100
|
+
streaming_callback=print_streaming_chunk,
|
|
101
|
+
api_base_url="test-base-url",
|
|
102
|
+
generation_kwargs={"max_tokens": 10, "response_format": CalendarEvent},
|
|
103
|
+
timeout=10,
|
|
104
|
+
max_retries=10,
|
|
105
|
+
http_client_kwargs={"proxy": "http://localhost:8080"},
|
|
106
|
+
)
|
|
107
|
+
init_parameters = component.to_dict()["init_parameters"]
|
|
108
|
+
|
|
109
|
+
assert init_parameters["api_key"] == {"env_vars": ["ENV_VAR"], "strict": True, "type": "env_var"}
|
|
110
|
+
assert init_parameters["model"] == "Qwen3.8-27B"
|
|
111
|
+
assert init_parameters["streaming_callback"] == "haystack.components.generators.utils.print_streaming_chunk"
|
|
112
|
+
assert init_parameters["api_base_url"] == "test-base-url"
|
|
113
|
+
assert init_parameters["timeout"] == 10
|
|
114
|
+
assert init_parameters["max_retries"] == 10
|
|
115
|
+
assert init_parameters["http_client_kwargs"] == {"proxy": "http://localhost:8080"}
|
|
116
|
+
# a Pydantic response_format is converted to OpenAI's JSON schema format, everything else is passed through
|
|
117
|
+
assert init_parameters["generation_kwargs"]["max_tokens"] == 10
|
|
118
|
+
response_format = init_parameters["generation_kwargs"]["response_format"]
|
|
119
|
+
assert response_format["type"] == "json_schema"
|
|
120
|
+
assert response_format["json_schema"]["name"] == "CalendarEvent"
|
|
121
|
+
assert response_format["json_schema"]["strict"] is True
|
|
122
|
+
assert response_format["json_schema"]["schema"]["required"] == ["event_name", "event_date"]
|
|
123
|
+
assert response_format["json_schema"]["schema"]["additionalProperties"] is False
|
|
124
|
+
|
|
125
|
+
def test_from_dict(self, monkeypatch):
|
|
126
|
+
monkeypatch.setenv("HETZNER_API_KEY", "fake-api-key")
|
|
127
|
+
component = HetznerChatGenerator.from_dict(
|
|
128
|
+
{
|
|
129
|
+
"type": COMPONENT_TYPE,
|
|
130
|
+
"init_parameters": {
|
|
131
|
+
"api_key": {"env_vars": ["HETZNER_API_KEY"], "strict": True, "type": "env_var"},
|
|
132
|
+
"model": DEFAULT_MODEL,
|
|
133
|
+
"api_base_url": "test-base-url",
|
|
134
|
+
"streaming_callback": "haystack.components.generators.utils.print_streaming_chunk",
|
|
135
|
+
"generation_kwargs": {"max_tokens": 10, "some_test_param": "test-params"},
|
|
136
|
+
"timeout": 10,
|
|
137
|
+
"max_retries": 10,
|
|
138
|
+
"tools": None,
|
|
139
|
+
"http_client_kwargs": {"proxy": "http://localhost:8080"},
|
|
140
|
+
},
|
|
141
|
+
}
|
|
142
|
+
)
|
|
143
|
+
|
|
144
|
+
assert component.api_key == Secret.from_env_var("HETZNER_API_KEY")
|
|
145
|
+
assert component.model == DEFAULT_MODEL
|
|
146
|
+
assert component.api_base_url == "test-base-url"
|
|
147
|
+
assert component.streaming_callback is print_streaming_chunk
|
|
148
|
+
assert component.generation_kwargs == {"max_tokens": 10, "some_test_param": "test-params"}
|
|
149
|
+
assert component.timeout == 10
|
|
150
|
+
assert component.max_retries == 10
|
|
151
|
+
assert component.tools is None
|
|
152
|
+
assert component.http_client_kwargs == {"proxy": "http://localhost:8080"}
|
|
153
|
+
|
|
154
|
+
def test_run(self, chat_messages, mock_chat_completion, monkeypatch):
|
|
155
|
+
monkeypatch.setenv("HETZNER_API_KEY", "fake-api-key")
|
|
156
|
+
component = HetznerChatGenerator(generation_kwargs={"max_tokens": 10, "temperature": 0.5})
|
|
157
|
+
response = component.run(chat_messages)
|
|
158
|
+
|
|
159
|
+
# the generation kwargs are passed on to the Hetzner endpoint
|
|
160
|
+
_, kwargs = mock_chat_completion.call_args
|
|
161
|
+
assert kwargs["model"] == DEFAULT_MODEL
|
|
162
|
+
assert kwargs["max_tokens"] == 10
|
|
163
|
+
assert kwargs["temperature"] == 0.5
|
|
164
|
+
|
|
165
|
+
assert len(response["replies"]) == 1
|
|
166
|
+
assert isinstance(response["replies"][0], ChatMessage)
|
|
167
|
+
assert response["replies"][0].text == "Hello world!"
|
|
168
|
+
|
|
169
|
+
def test_serde_in_pipeline(self, monkeypatch, tools):
|
|
170
|
+
monkeypatch.setenv("ENV_VAR", "test-key")
|
|
171
|
+
generator = HetznerChatGenerator(
|
|
172
|
+
api_key=Secret.from_env_var("ENV_VAR"),
|
|
173
|
+
generation_kwargs={"temperature": 0.7},
|
|
174
|
+
streaming_callback=print_streaming_chunk,
|
|
175
|
+
tools=tools,
|
|
176
|
+
)
|
|
177
|
+
pipeline = Pipeline()
|
|
178
|
+
pipeline.add_component("generator", generator)
|
|
179
|
+
|
|
180
|
+
component_dict = pipeline.to_dict()["components"]["generator"]
|
|
181
|
+
assert component_dict["type"] == COMPONENT_TYPE
|
|
182
|
+
assert component_dict["init_parameters"]["generation_kwargs"] == {"temperature": 0.7}
|
|
183
|
+
|
|
184
|
+
# the Tool serialization format is owned by haystack-ai and varies across its versions, so
|
|
185
|
+
# round-trip the tools through YAML instead of pinning their serialized form
|
|
186
|
+
new_pipeline = Pipeline.loads(pipeline.dumps())
|
|
187
|
+
assert new_pipeline == pipeline
|
|
188
|
+
loaded_generator = new_pipeline.get_component("generator")
|
|
189
|
+
assert loaded_generator.model == generator.model
|
|
190
|
+
assert loaded_generator.generation_kwargs == generator.generation_kwargs
|
|
191
|
+
assert loaded_generator.streaming_callback is print_streaming_chunk
|
|
192
|
+
assert [tool.name for tool in loaded_generator.tools] == [tool.name for tool in tools]
|
|
193
|
+
assert [tool.parameters for tool in loaded_generator.tools] == [tool.parameters for tool in tools]
|
|
194
|
+
|
|
195
|
+
@requires_api_key
|
|
196
|
+
@pytest.mark.integration
|
|
197
|
+
def test_live_run(self):
|
|
198
|
+
results = HetznerChatGenerator().run([ChatMessage.from_user("What's the capital of France")])
|
|
199
|
+
|
|
200
|
+
assert len(results["replies"]) == 1
|
|
201
|
+
message = results["replies"][0]
|
|
202
|
+
assert "Paris" in message.text
|
|
203
|
+
assert DEFAULT_MODEL in message.meta["model"]
|
|
204
|
+
assert message.meta["finish_reason"] == "stop"
|
|
205
|
+
|
|
206
|
+
@requires_api_key
|
|
207
|
+
@pytest.mark.integration
|
|
208
|
+
def test_live_run_streaming(self):
|
|
209
|
+
chunks = []
|
|
210
|
+
|
|
211
|
+
def callback(chunk: StreamingChunk) -> None:
|
|
212
|
+
chunks.append(chunk)
|
|
213
|
+
|
|
214
|
+
component = HetznerChatGenerator(streaming_callback=callback)
|
|
215
|
+
results = component.run([ChatMessage.from_user("What's the capital of France?")])
|
|
216
|
+
|
|
217
|
+
message = results["replies"][0]
|
|
218
|
+
assert "Paris" in message.text
|
|
219
|
+
assert message.meta["finish_reason"] == "stop"
|
|
220
|
+
assert len(chunks) > 1
|
|
221
|
+
assert "Paris" in "".join(chunk.content for chunk in chunks if chunk.content)
|
|
222
|
+
|
|
223
|
+
@requires_api_key
|
|
224
|
+
@pytest.mark.integration
|
|
225
|
+
def test_live_run_with_tools_and_response(self, tools):
|
|
226
|
+
initial_messages = [ChatMessage.from_user("What's the weather like in Paris and Berlin?")]
|
|
227
|
+
component = HetznerChatGenerator(tools=tools)
|
|
228
|
+
results = component.run(messages=initial_messages, generation_kwargs={"tool_choice": "auto"})
|
|
229
|
+
|
|
230
|
+
assert len(results["replies"]) == 1
|
|
231
|
+
tool_message = results["replies"][0]
|
|
232
|
+
assert ChatMessage.is_from(tool_message, ChatRole.ASSISTANT)
|
|
233
|
+
assert tool_message.meta["finish_reason"] == "tool_calls"
|
|
234
|
+
|
|
235
|
+
# the model requests the tool once per city, in a single reply
|
|
236
|
+
tool_calls = tool_message.tool_calls
|
|
237
|
+
assert len(tool_calls) == 2
|
|
238
|
+
assert all(tool_call.id and tool_call.tool_name == "weather" for tool_call in tool_calls)
|
|
239
|
+
assert sorted((tool_call.arguments for tool_call in tool_calls), key=lambda args: args["city"]) == [
|
|
240
|
+
{"city": "Berlin"},
|
|
241
|
+
{"city": "Paris"},
|
|
242
|
+
]
|
|
243
|
+
|
|
244
|
+
# pass the tool results back to the model to get the final response
|
|
245
|
+
results = component.run(
|
|
246
|
+
[
|
|
247
|
+
initial_messages[0],
|
|
248
|
+
tool_message,
|
|
249
|
+
ChatMessage.from_tool(tool_result="22° C and sunny", origin=tool_calls[0]),
|
|
250
|
+
ChatMessage.from_tool(tool_result="16° C and windy", origin=tool_calls[1]),
|
|
251
|
+
]
|
|
252
|
+
)
|
|
253
|
+
final_message = results["replies"][0]
|
|
254
|
+
assert final_message.is_from(ChatRole.ASSISTANT)
|
|
255
|
+
assert "paris" in final_message.text.lower()
|
|
256
|
+
assert "berlin" in final_message.text.lower()
|
|
257
|
+
|
|
258
|
+
@requires_api_key
|
|
259
|
+
@pytest.mark.integration
|
|
260
|
+
def test_live_run_with_response_format(self):
|
|
261
|
+
component = HetznerChatGenerator(generation_kwargs={"response_format": CalendarEvent})
|
|
262
|
+
results = component.run([ChatMessage.from_user("The marketing summit takes place on October 12th.")])
|
|
263
|
+
|
|
264
|
+
event = json.loads(results["replies"][0].text)
|
|
265
|
+
assert "marketing summit" in event["event_name"].lower()
|
|
266
|
+
assert isinstance(event["event_date"], str)
|
|
267
|
+
|
|
268
|
+
@requires_api_key
|
|
269
|
+
@pytest.mark.integration
|
|
270
|
+
def test_live_run_with_image(self):
|
|
271
|
+
image = ImageContent(base64_image=RED_SQUARE_PNG, mime_type="image/png")
|
|
272
|
+
component = HetznerChatGenerator()
|
|
273
|
+
results = component.run([ChatMessage.from_user(content_parts=["What color is this image?", image])])
|
|
274
|
+
|
|
275
|
+
message = results["replies"][0]
|
|
276
|
+
# the model names the color in its own words, so accept any reddish description
|
|
277
|
+
assert any(color in message.text.lower() for color in ("red", "crimson", "scarlet"))
|
|
278
|
+
assert message.meta["finish_reason"] == "stop"
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
|
|
2
|
+
#
|
|
3
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
4
|
+
|
|
5
|
+
import os
|
|
6
|
+
from unittest.mock import AsyncMock, patch
|
|
7
|
+
|
|
8
|
+
import pytest
|
|
9
|
+
from haystack.dataclasses import ChatMessage, ChatRole, StreamingChunk
|
|
10
|
+
from openai.types.chat import ChatCompletion, ChatCompletionMessage
|
|
11
|
+
from openai.types.chat.chat_completion import Choice
|
|
12
|
+
from openai.types.completion_usage import CompletionUsage
|
|
13
|
+
|
|
14
|
+
from haystack_integrations.components.generators.hetzner.chat.chat_generator import HetznerChatGenerator
|
|
15
|
+
|
|
16
|
+
DEFAULT_MODEL = "Qwen/Qwen3.6-35B-A3B-FP8"
|
|
17
|
+
|
|
18
|
+
requires_api_key = pytest.mark.skipif(
|
|
19
|
+
not os.environ.get("HETZNER_API_KEY", None),
|
|
20
|
+
reason="Export an env var called HETZNER_API_KEY containing the Hetzner API token to run this test.",
|
|
21
|
+
)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
@pytest.fixture
|
|
25
|
+
def mock_async_chat_completion():
|
|
26
|
+
"""Mock the async Hetzner (OpenAI-compatible) chat completion response and reuse it for tests."""
|
|
27
|
+
with patch(
|
|
28
|
+
"openai.resources.chat.completions.AsyncCompletions.create", new_callable=AsyncMock
|
|
29
|
+
) as mock_chat_completion_create:
|
|
30
|
+
mock_chat_completion_create.return_value = ChatCompletion(
|
|
31
|
+
id="foo",
|
|
32
|
+
model=DEFAULT_MODEL,
|
|
33
|
+
object="chat.completion",
|
|
34
|
+
choices=[
|
|
35
|
+
Choice(
|
|
36
|
+
finish_reason="stop",
|
|
37
|
+
logprobs=None,
|
|
38
|
+
index=0,
|
|
39
|
+
message=ChatCompletionMessage(content="Hello world!", role="assistant"),
|
|
40
|
+
)
|
|
41
|
+
],
|
|
42
|
+
created=1750162525,
|
|
43
|
+
usage=CompletionUsage(prompt_tokens=57, completion_tokens=40, total_tokens=97),
|
|
44
|
+
)
|
|
45
|
+
yield mock_chat_completion_create
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
@pytest.mark.asyncio
|
|
49
|
+
class TestHetznerChatGeneratorAsync:
|
|
50
|
+
async def test_run_async(self, chat_messages, mock_async_chat_completion, monkeypatch):
|
|
51
|
+
monkeypatch.setenv("HETZNER_API_KEY", "fake-api-key")
|
|
52
|
+
component = HetznerChatGenerator(generation_kwargs={"max_tokens": 10, "temperature": 0.5})
|
|
53
|
+
response = await component.run_async(chat_messages)
|
|
54
|
+
|
|
55
|
+
# the generation kwargs are passed on to the Hetzner endpoint
|
|
56
|
+
_, kwargs = mock_async_chat_completion.call_args
|
|
57
|
+
assert kwargs["model"] == DEFAULT_MODEL
|
|
58
|
+
assert kwargs["max_tokens"] == 10
|
|
59
|
+
assert kwargs["temperature"] == 0.5
|
|
60
|
+
|
|
61
|
+
assert len(response["replies"]) == 1
|
|
62
|
+
assert isinstance(response["replies"][0], ChatMessage)
|
|
63
|
+
assert response["replies"][0].text == "Hello world!"
|
|
64
|
+
|
|
65
|
+
@requires_api_key
|
|
66
|
+
@pytest.mark.integration
|
|
67
|
+
async def test_live_run_async(self):
|
|
68
|
+
results = await HetznerChatGenerator().run_async([ChatMessage.from_user("What's the capital of France")])
|
|
69
|
+
|
|
70
|
+
assert len(results["replies"]) == 1
|
|
71
|
+
message = results["replies"][0]
|
|
72
|
+
assert "Paris" in message.text
|
|
73
|
+
assert DEFAULT_MODEL in message.meta["model"]
|
|
74
|
+
assert message.meta["finish_reason"] == "stop"
|
|
75
|
+
|
|
76
|
+
@requires_api_key
|
|
77
|
+
@pytest.mark.integration
|
|
78
|
+
async def test_live_run_with_tools_streaming_async(self, tools):
|
|
79
|
+
chunks = []
|
|
80
|
+
|
|
81
|
+
async def callback(chunk: StreamingChunk) -> None:
|
|
82
|
+
chunks.append(chunk)
|
|
83
|
+
|
|
84
|
+
component = HetznerChatGenerator(tools=tools, streaming_callback=callback)
|
|
85
|
+
results = await component.run_async(
|
|
86
|
+
[ChatMessage.from_user("What's the weather like in Paris?")],
|
|
87
|
+
generation_kwargs={"tool_choice": "auto"},
|
|
88
|
+
)
|
|
89
|
+
|
|
90
|
+
assert len(chunks) > 1
|
|
91
|
+
assert any(chunk.meta.get("tool_calls") for chunk in chunks), "No tool calls received in streaming"
|
|
92
|
+
|
|
93
|
+
tool_message = results["replies"][0]
|
|
94
|
+
assert ChatMessage.is_from(tool_message, ChatRole.ASSISTANT)
|
|
95
|
+
assert tool_message.meta["finish_reason"] == "tool_calls"
|
|
96
|
+
tool_call = tool_message.tool_call
|
|
97
|
+
assert tool_call.id
|
|
98
|
+
assert tool_call.tool_name == "weather"
|
|
99
|
+
assert tool_call.arguments == {"city": "Paris"}
|