scavio-haystack 0.1.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.
@@ -0,0 +1,38 @@
1
+ # SPDX-FileCopyrightText: 2026-present Scavio <scavio.dev@gmail.com>
2
+ #
3
+ # SPDX-License-Identifier: Apache-2.0
4
+
5
+ name: Release
6
+
7
+ on:
8
+ push:
9
+ tags:
10
+ - "v[0-9].[0-9]+.[0-9]+*"
11
+
12
+ jobs:
13
+ release-on-pypi:
14
+ name: Publish on PyPI
15
+ runs-on: ubuntu-latest
16
+ permissions:
17
+ # Required for PyPI Trusted Publishing (OIDC); no API token needed.
18
+ id-token: write
19
+ steps:
20
+ - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
21
+ with:
22
+ fetch-depth: 0
23
+
24
+ - name: Set up Python
25
+ uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
26
+ with:
27
+ python-version: "3.13"
28
+
29
+ - name: Install Hatch
30
+ run: |
31
+ python -m pip install --upgrade pip
32
+ pip install hatch
33
+
34
+ - name: Build
35
+ run: hatch build
36
+
37
+ - name: Publish to PyPI
38
+ uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,48 @@
1
+ # SPDX-FileCopyrightText: 2026-present Scavio <scavio.dev@gmail.com>
2
+ #
3
+ # SPDX-License-Identifier: Apache-2.0
4
+
5
+ name: Test
6
+
7
+ on:
8
+ push:
9
+ branches: [main]
10
+ pull_request:
11
+
12
+ concurrency:
13
+ group: test-${{ github.head_ref }}
14
+ cancel-in-progress: true
15
+
16
+ env:
17
+ PYTHONUNBUFFERED: "1"
18
+ FORCE_COLOR: "1"
19
+
20
+ jobs:
21
+ test:
22
+ name: Python ${{ matrix.python-version }} on ${{ startsWith(matrix.os, 'macos-') && 'macOS' || startsWith(matrix.os, 'windows-') && 'Windows' || 'Linux' }}
23
+ runs-on: ${{ matrix.os }}
24
+ strategy:
25
+ fail-fast: false
26
+ matrix:
27
+ os: [ubuntu-latest]
28
+ python-version: ["3.10", "3.14"]
29
+
30
+ steps:
31
+ - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
32
+
33
+ - name: Set up Python ${{ matrix.python-version }}
34
+ uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
35
+ with:
36
+ python-version: ${{ matrix.python-version }}
37
+
38
+ - name: Install Hatch
39
+ run: |
40
+ python -m pip install --upgrade pip
41
+ pip install hatch
42
+
43
+ - name: Lint
44
+ if: matrix.python-version == '3.10' && runner.os == 'Linux'
45
+ run: hatch run fmt-check
46
+
47
+ - name: Run tests
48
+ run: hatch run test:unit
@@ -0,0 +1,207 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[codz]
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
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py.cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
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
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # UV
98
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ #uv.lock
102
+
103
+ # poetry
104
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
106
+ # commonly ignored for libraries.
107
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108
+ #poetry.lock
109
+ #poetry.toml
110
+
111
+ # pdm
112
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115
+ #pdm.lock
116
+ #pdm.toml
117
+ .pdm-python
118
+ .pdm-build/
119
+
120
+ # pixi
121
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122
+ #pixi.lock
123
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124
+ # in the .venv directory. It is recommended not to include this directory in version control.
125
+ .pixi
126
+
127
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128
+ __pypackages__/
129
+
130
+ # Celery stuff
131
+ celerybeat-schedule
132
+ celerybeat.pid
133
+
134
+ # SageMath parsed files
135
+ *.sage.py
136
+
137
+ # Environments
138
+ .env
139
+ .envrc
140
+ .venv
141
+ env/
142
+ venv/
143
+ ENV/
144
+ env.bak/
145
+ venv.bak/
146
+
147
+ # Spyder project settings
148
+ .spyderproject
149
+ .spyproject
150
+
151
+ # Rope project settings
152
+ .ropeproject
153
+
154
+ # mkdocs documentation
155
+ /site
156
+
157
+ # mypy
158
+ .mypy_cache/
159
+ .dmypy.json
160
+ dmypy.json
161
+
162
+ # Pyre type checker
163
+ .pyre/
164
+
165
+ # pytype static type analyzer
166
+ .pytype/
167
+
168
+ # Cython debug symbols
169
+ cython_debug/
170
+
171
+ # PyCharm
172
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
173
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
174
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
175
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
176
+ #.idea/
177
+
178
+ # Abstra
179
+ # Abstra is an AI-powered process automation framework.
180
+ # Ignore directories containing user credentials, local state, and settings.
181
+ # Learn more at https://abstra.io/docs
182
+ .abstra/
183
+
184
+ # Visual Studio Code
185
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
186
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
187
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
188
+ # you could uncomment the following to ignore the entire vscode folder
189
+ # .vscode/
190
+
191
+ # Ruff stuff:
192
+ .ruff_cache/
193
+
194
+ # PyPI configuration file
195
+ .pypirc
196
+
197
+ # Cursor
198
+ # Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
199
+ # exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
200
+ # refer to https://docs.cursor.com/context/ignore-files
201
+ .cursorignore
202
+ .cursorindexingignore
203
+
204
+ # Marimo
205
+ marimo/_static/
206
+ marimo/_lsp/
207
+ __marimo__/
@@ -0,0 +1,8 @@
1
+ # Changelog
2
+
3
+ ## [v0.1.0]
4
+
5
+ ### Features
6
+
7
+ - Add `ScavioWebSearch` component: web search backed by the Scavio API, returning
8
+ Haystack `Document`s and source links, with sync `run` and async `run_async`.
@@ -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 [yyyy] [name of copyright owner]
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,131 @@
1
+ Metadata-Version: 2.4
2
+ Name: scavio-haystack
3
+ Version: 0.1.0
4
+ Summary: Haystack integration for Scavio Web Search
5
+ Project-URL: Documentation, https://github.com/scavio-ai/haystack-scavio#readme
6
+ Project-URL: Issues, https://github.com/scavio-ai/haystack-scavio/issues
7
+ Project-URL: Source, https://github.com/scavio-ai/haystack-scavio
8
+ Author-email: Scavio <scavio.dev@gmail.com>
9
+ License-Expression: Apache-2.0
10
+ License-File: LICENSE
11
+ Keywords: AI Search,Haystack,Scavio,Web Search
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: Apache Software License
15
+ Classifier: Programming Language :: Python
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Programming Language :: Python :: 3.14
21
+ Classifier: Programming Language :: Python :: Implementation :: CPython
22
+ Classifier: Programming Language :: Python :: Implementation :: PyPy
23
+ Requires-Python: >=3.10
24
+ Requires-Dist: haystack-ai>=2.24.1
25
+ Requires-Dist: scavio>=0.2.1
26
+ Description-Content-Type: text/markdown
27
+
28
+ # scavio-haystack
29
+
30
+ [![PyPI - Version](https://img.shields.io/pypi/v/scavio-haystack.svg)](https://pypi.org/project/scavio-haystack)
31
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/scavio-haystack.svg)](https://pypi.org/project/scavio-haystack)
32
+
33
+ [Scavio](https://scavio.dev) integration for [Haystack](https://haystack.deepset.ai) by deepset.
34
+
35
+ Provides `ScavioWebSearch`, a web search component backed by the Scavio API. It returns results
36
+ as Haystack `Document` objects (with title and URL metadata) plus the list of source links, and
37
+ mirrors the existing `TavilyWebSearch` / `ExaWebSearch` components.
38
+
39
+ Scavio is a unified search API for AI agents. Get an API key at
40
+ [dashboard.scavio.dev](https://dashboard.scavio.dev).
41
+
42
+ ## Installation
43
+
44
+ ```bash
45
+ pip install scavio-haystack
46
+ ```
47
+
48
+ ## Usage
49
+
50
+ ```python
51
+ from haystack_integrations.components.websearch.scavio import ScavioWebSearch
52
+ from haystack.utils import Secret
53
+
54
+ web_search = ScavioWebSearch(
55
+ api_key=Secret.from_env_var("SCAVIO_API_KEY"), # defaults to SCAVIO_API_KEY
56
+ top_k=5,
57
+ )
58
+
59
+ result = web_search.run(query="What is Haystack by deepset?")
60
+ documents = result["documents"]
61
+ links = result["links"]
62
+ ```
63
+
64
+ ### In a pipeline
65
+
66
+ ```python
67
+ from haystack import Pipeline
68
+ from haystack.components.builders import PromptBuilder
69
+ from haystack.components.generators import OpenAIGenerator
70
+ from haystack_integrations.components.websearch.scavio import ScavioWebSearch
71
+
72
+ template = """
73
+ Given the following web search results, answer the question.
74
+
75
+ Results:
76
+ {% for doc in documents %}{{ doc.content }}
77
+ {% endfor %}
78
+
79
+ Question: {{ query }}
80
+ Answer:
81
+ """
82
+
83
+ pipe = Pipeline()
84
+ pipe.add_component("search", ScavioWebSearch(top_k=5))
85
+ pipe.add_component("prompt_builder", PromptBuilder(template=template))
86
+ pipe.add_component("llm", OpenAIGenerator())
87
+ pipe.connect("search.documents", "prompt_builder.documents")
88
+ pipe.connect("prompt_builder", "llm")
89
+
90
+ query = "What is Haystack by deepset?"
91
+ result = pipe.run(data={"search": {"query": query}, "prompt_builder": {"query": query}})
92
+ print(result["llm"]["replies"][0])
93
+ ```
94
+
95
+ ### Async support
96
+
97
+ ```python
98
+ import asyncio
99
+ from haystack_integrations.components.websearch.scavio import ScavioWebSearch
100
+
101
+ async def main():
102
+ web_search = ScavioWebSearch(top_k=3)
103
+ result = await web_search.run_async(query="What is Haystack by deepset?")
104
+ print(f"Found {len(result['documents'])} documents")
105
+
106
+ asyncio.run(main())
107
+ ```
108
+
109
+ ## Parameters
110
+
111
+ - **`api_key`**: API key for Scavio. Defaults to the `SCAVIO_API_KEY` environment variable.
112
+ - **`top_k`**: Maximum number of results to return. Defaults to 10.
113
+ - **`search_params`**: Additional parameters passed to the Scavio Google search endpoint.
114
+ Supported keys include `country_code`, `language`, `page`, `search_type`, `device`, `nfpr`,
115
+ `light_request`. Can be set at init time or overridden per `run`.
116
+
117
+ ## Development
118
+
119
+ This project uses [Hatch](https://hatch.pypa.io/).
120
+
121
+ ```bash
122
+ pip install hatch
123
+
124
+ hatch run fmt-check # lint + format check
125
+ hatch run test:unit # unit tests
126
+ hatch run test:all # all tests (set SCAVIO_API_KEY for integration tests)
127
+ ```
128
+
129
+ ## License
130
+
131
+ `scavio-haystack` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.
@@ -0,0 +1,104 @@
1
+ # scavio-haystack
2
+
3
+ [![PyPI - Version](https://img.shields.io/pypi/v/scavio-haystack.svg)](https://pypi.org/project/scavio-haystack)
4
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/scavio-haystack.svg)](https://pypi.org/project/scavio-haystack)
5
+
6
+ [Scavio](https://scavio.dev) integration for [Haystack](https://haystack.deepset.ai) by deepset.
7
+
8
+ Provides `ScavioWebSearch`, a web search component backed by the Scavio API. It returns results
9
+ as Haystack `Document` objects (with title and URL metadata) plus the list of source links, and
10
+ mirrors the existing `TavilyWebSearch` / `ExaWebSearch` components.
11
+
12
+ Scavio is a unified search API for AI agents. Get an API key at
13
+ [dashboard.scavio.dev](https://dashboard.scavio.dev).
14
+
15
+ ## Installation
16
+
17
+ ```bash
18
+ pip install scavio-haystack
19
+ ```
20
+
21
+ ## Usage
22
+
23
+ ```python
24
+ from haystack_integrations.components.websearch.scavio import ScavioWebSearch
25
+ from haystack.utils import Secret
26
+
27
+ web_search = ScavioWebSearch(
28
+ api_key=Secret.from_env_var("SCAVIO_API_KEY"), # defaults to SCAVIO_API_KEY
29
+ top_k=5,
30
+ )
31
+
32
+ result = web_search.run(query="What is Haystack by deepset?")
33
+ documents = result["documents"]
34
+ links = result["links"]
35
+ ```
36
+
37
+ ### In a pipeline
38
+
39
+ ```python
40
+ from haystack import Pipeline
41
+ from haystack.components.builders import PromptBuilder
42
+ from haystack.components.generators import OpenAIGenerator
43
+ from haystack_integrations.components.websearch.scavio import ScavioWebSearch
44
+
45
+ template = """
46
+ Given the following web search results, answer the question.
47
+
48
+ Results:
49
+ {% for doc in documents %}{{ doc.content }}
50
+ {% endfor %}
51
+
52
+ Question: {{ query }}
53
+ Answer:
54
+ """
55
+
56
+ pipe = Pipeline()
57
+ pipe.add_component("search", ScavioWebSearch(top_k=5))
58
+ pipe.add_component("prompt_builder", PromptBuilder(template=template))
59
+ pipe.add_component("llm", OpenAIGenerator())
60
+ pipe.connect("search.documents", "prompt_builder.documents")
61
+ pipe.connect("prompt_builder", "llm")
62
+
63
+ query = "What is Haystack by deepset?"
64
+ result = pipe.run(data={"search": {"query": query}, "prompt_builder": {"query": query}})
65
+ print(result["llm"]["replies"][0])
66
+ ```
67
+
68
+ ### Async support
69
+
70
+ ```python
71
+ import asyncio
72
+ from haystack_integrations.components.websearch.scavio import ScavioWebSearch
73
+
74
+ async def main():
75
+ web_search = ScavioWebSearch(top_k=3)
76
+ result = await web_search.run_async(query="What is Haystack by deepset?")
77
+ print(f"Found {len(result['documents'])} documents")
78
+
79
+ asyncio.run(main())
80
+ ```
81
+
82
+ ## Parameters
83
+
84
+ - **`api_key`**: API key for Scavio. Defaults to the `SCAVIO_API_KEY` environment variable.
85
+ - **`top_k`**: Maximum number of results to return. Defaults to 10.
86
+ - **`search_params`**: Additional parameters passed to the Scavio Google search endpoint.
87
+ Supported keys include `country_code`, `language`, `page`, `search_type`, `device`, `nfpr`,
88
+ `light_request`. Can be set at init time or overridden per `run`.
89
+
90
+ ## Development
91
+
92
+ This project uses [Hatch](https://hatch.pypa.io/).
93
+
94
+ ```bash
95
+ pip install hatch
96
+
97
+ hatch run fmt-check # lint + format check
98
+ hatch run test:unit # unit tests
99
+ hatch run test:all # all tests (set SCAVIO_API_KEY for integration tests)
100
+ ```
101
+
102
+ ## License
103
+
104
+ `scavio-haystack` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.
@@ -0,0 +1,15 @@
1
+ # SPDX-FileCopyrightText: 2026-present Scavio <scavio.dev@gmail.com>
2
+ #
3
+ # SPDX-License-Identifier: Apache-2.0
4
+
5
+ # Minimal example: search the web with Scavio and inspect the returned Documents.
6
+ # Export your key first: export SCAVIO_API_KEY=sk_live_your_key
7
+ from haystack_integrations.components.websearch.scavio import ScavioWebSearch
8
+
9
+ web_search = ScavioWebSearch(top_k=5)
10
+
11
+ result = web_search.run(query="What is Haystack by deepset?")
12
+ for doc in result["documents"]:
13
+ print(doc.meta["title"], "-", doc.meta["url"])
14
+
15
+ print(result["links"])
@@ -0,0 +1,162 @@
1
+ # SPDX-FileCopyrightText: 2026-present Scavio <scavio.dev@gmail.com>
2
+ #
3
+ # SPDX-License-Identifier: Apache-2.0
4
+
5
+ [build-system]
6
+ requires = ["hatchling", "hatch-vcs"]
7
+ build-backend = "hatchling.build"
8
+
9
+ [project]
10
+ name = "scavio-haystack"
11
+ dynamic = ["version"]
12
+ description = "Haystack integration for Scavio Web Search"
13
+ readme = "README.md"
14
+ requires-python = ">=3.10"
15
+ license = "Apache-2.0"
16
+ keywords = ["Haystack", "Scavio", "Web Search", "AI Search"]
17
+ authors = [{ name = "Scavio", email = "scavio.dev@gmail.com" }]
18
+ classifiers = [
19
+ "License :: OSI Approved :: Apache Software License",
20
+ "Development Status :: 4 - Beta",
21
+ "Intended Audience :: Developers",
22
+ "Programming Language :: Python",
23
+ "Programming Language :: Python :: 3.10",
24
+ "Programming Language :: Python :: 3.11",
25
+ "Programming Language :: Python :: 3.12",
26
+ "Programming Language :: Python :: 3.13",
27
+ "Programming Language :: Python :: 3.14",
28
+ "Programming Language :: Python :: Implementation :: CPython",
29
+ "Programming Language :: Python :: Implementation :: PyPy",
30
+ ]
31
+ dependencies = ["haystack-ai>=2.24.1", "scavio>=0.2.1"]
32
+
33
+ [project.urls]
34
+ Documentation = "https://github.com/scavio-ai/haystack-scavio#readme"
35
+ Issues = "https://github.com/scavio-ai/haystack-scavio/issues"
36
+ Source = "https://github.com/scavio-ai/haystack-scavio"
37
+
38
+ [tool.hatch.build.targets.wheel]
39
+ packages = ["src/haystack_integrations"]
40
+
41
+ [tool.hatch.version]
42
+ source = "vcs"
43
+ tag-pattern = "v(?P<version>.*)"
44
+
45
+ [tool.hatch.version.raw-options]
46
+ git_describe_command = 'git describe --tags --match="v[0-9]*"'
47
+
48
+ [tool.hatch.envs.default]
49
+ installer = "uv"
50
+ dependencies = ["ruff"]
51
+
52
+ [tool.hatch.envs.default.scripts]
53
+ fmt = "ruff check --fix {args}; ruff format {args}"
54
+ fmt-check = "ruff check {args} && ruff format --check {args}"
55
+
56
+ [tool.hatch.envs.test]
57
+ dependencies = [
58
+ "pytest",
59
+ "pytest-asyncio",
60
+ "pytest-cov",
61
+ "pytest-rerunfailures",
62
+ "mypy",
63
+ "pip",
64
+ ]
65
+
66
+ [tool.hatch.envs.test.scripts]
67
+ unit = 'pytest -m "not integration" {args:tests}'
68
+ integration = 'pytest -m "integration" {args:tests}'
69
+ all = 'pytest {args:tests}'
70
+ cov = 'pytest --cov=haystack_integrations {args:tests}'
71
+ types = "mypy -p haystack_integrations.components.websearch.scavio {args}"
72
+
73
+ [tool.mypy]
74
+ install_types = true
75
+ non_interactive = true
76
+ check_untyped_defs = true
77
+ disallow_incomplete_defs = true
78
+
79
+ [[tool.mypy.overrides]]
80
+ module = ["scavio.*"]
81
+ ignore_missing_imports = true
82
+
83
+ [tool.ruff]
84
+ line-length = 120
85
+
86
+ [tool.ruff.lint]
87
+ select = [
88
+ "A",
89
+ "ANN",
90
+ "ARG",
91
+ "B",
92
+ "C",
93
+ "D102",
94
+ "D103",
95
+ "D205",
96
+ "D209",
97
+ "D213",
98
+ "D417",
99
+ "D419",
100
+ "DTZ",
101
+ "E",
102
+ "EM",
103
+ "F",
104
+ "I",
105
+ "ICN",
106
+ "ISC",
107
+ "N",
108
+ "PLC",
109
+ "PLE",
110
+ "PLR",
111
+ "PLW",
112
+ "Q",
113
+ "RUF",
114
+ "S",
115
+ "T",
116
+ "TID",
117
+ "UP",
118
+ "W",
119
+ "YTT",
120
+ ]
121
+ ignore = [
122
+ "B027",
123
+ "B008",
124
+ "S105",
125
+ "S106",
126
+ "S107",
127
+ "C901",
128
+ "PLR0911",
129
+ "PLR0912",
130
+ "PLR0913",
131
+ "PLR0915",
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/**/*" = ["PLR2004", "S101", "TID252", "D", "ANN"]
143
+ "examples/**/*" = ["D", "T201", "ANN"]
144
+
145
+ [tool.coverage.run]
146
+ source = ["haystack_integrations"]
147
+ branch = true
148
+ relative_files = true
149
+ parallel = false
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,7 @@
1
+ # SPDX-FileCopyrightText: 2026-present Scavio <scavio.dev@gmail.com>
2
+ #
3
+ # SPDX-License-Identifier: Apache-2.0
4
+
5
+ from haystack_integrations.components.websearch.scavio.scavio_websearch import ScavioWebSearch
6
+
7
+ __all__ = ["ScavioWebSearch"]
@@ -0,0 +1,156 @@
1
+ # SPDX-FileCopyrightText: 2026-present Scavio <scavio.dev@gmail.com>
2
+ #
3
+ # SPDX-License-Identifier: Apache-2.0
4
+
5
+ from typing import Any
6
+
7
+ from haystack import Document, component, logging
8
+ from haystack.utils import Secret
9
+
10
+ from scavio import AsyncScavioClient, ScavioClient
11
+
12
+ logger = logging.getLogger(__name__)
13
+
14
+
15
+ @component
16
+ class ScavioWebSearch:
17
+ """
18
+ A component that uses Scavio to search the web and return results as Haystack Documents.
19
+
20
+ This component wraps the Scavio Google web search endpoint, enabling real-time web search
21
+ queries that return structured documents with content and links.
22
+
23
+ Scavio is a unified search API for AI agents. You need a Scavio API key from
24
+ [dashboard.scavio.dev](https://dashboard.scavio.dev).
25
+
26
+ ### Usage example
27
+
28
+ ```python
29
+ from haystack_integrations.components.websearch.scavio import ScavioWebSearch
30
+ from haystack.utils import Secret
31
+
32
+ websearch = ScavioWebSearch(
33
+ api_key=Secret.from_env_var("SCAVIO_API_KEY"),
34
+ top_k=5,
35
+ )
36
+ result = websearch.run(query="What is Haystack by deepset?")
37
+ documents = result["documents"]
38
+ links = result["links"]
39
+ ```
40
+ """
41
+
42
+ def __init__(
43
+ self,
44
+ api_key: Secret = Secret.from_env_var("SCAVIO_API_KEY"),
45
+ top_k: int | None = 10,
46
+ search_params: dict[str, Any] | None = None,
47
+ ) -> None:
48
+ """
49
+ Initialize the ScavioWebSearch component.
50
+
51
+ :param api_key:
52
+ API key for Scavio. Defaults to the `SCAVIO_API_KEY` environment variable.
53
+ :param top_k:
54
+ Maximum number of results to return.
55
+ :param search_params:
56
+ Additional parameters passed to the Scavio Google search endpoint. Supported keys
57
+ include: `country_code`, `language`, `page`, `search_type`, `device`, `nfpr`,
58
+ `light_request`.
59
+ """
60
+ self.api_key = api_key
61
+ self.top_k = top_k
62
+ self.search_params = search_params
63
+ self._scavio_client: ScavioClient | None = None
64
+ self._async_scavio_client: AsyncScavioClient | None = None
65
+
66
+ def warm_up(self) -> None:
67
+ """
68
+ Initialize the Scavio sync and async clients.
69
+
70
+ Called automatically on first use. Can be called explicitly to avoid cold-start latency.
71
+ """
72
+ if self._scavio_client is None:
73
+ self._scavio_client = ScavioClient(api_key=self.api_key.resolve_value())
74
+ if self._async_scavio_client is None:
75
+ self._async_scavio_client = AsyncScavioClient(api_key=self.api_key.resolve_value())
76
+
77
+ @component.output_types(documents=list[Document], links=list[str])
78
+ def run(
79
+ self,
80
+ query: str,
81
+ search_params: dict[str, Any] | None = None,
82
+ ) -> dict[str, Any]:
83
+ """
84
+ Search the web using Scavio and return results as Documents.
85
+
86
+ :param query: Search query string.
87
+ :param search_params:
88
+ Optional per-run override of search parameters.
89
+ If provided, fully replaces the init-time `search_params`.
90
+ :returns: A dictionary with:
91
+ - `documents`: List of Documents containing search result content.
92
+ - `links`: List of URLs from the search results.
93
+ """
94
+ if self._scavio_client is None:
95
+ self.warm_up()
96
+ if self._scavio_client is None:
97
+ msg = "ScavioWebSearch client failed to initialize."
98
+ raise RuntimeError(msg)
99
+
100
+ params = (search_params if search_params is not None else self.search_params or {}).copy()
101
+ response = self._scavio_client.google.search(query, **params)
102
+ return self._parse_response(response, self.top_k)
103
+
104
+ @component.output_types(documents=list[Document], links=list[str])
105
+ async def run_async(
106
+ self,
107
+ query: str,
108
+ search_params: dict[str, Any] | None = None,
109
+ ) -> dict[str, Any]:
110
+ """
111
+ Asynchronously search the web using Scavio and return results as Documents.
112
+
113
+ :param query: Search query string.
114
+ :param search_params:
115
+ Optional per-run override of search parameters.
116
+ If provided, fully replaces the init-time `search_params`.
117
+ :returns: A dictionary with:
118
+ - `documents`: List of Documents containing search result content.
119
+ - `links`: List of URLs from the search results.
120
+ """
121
+ if self._async_scavio_client is None:
122
+ self.warm_up()
123
+ if self._async_scavio_client is None:
124
+ msg = "ScavioWebSearch async client failed to initialize."
125
+ raise RuntimeError(msg)
126
+
127
+ params = (search_params if search_params is not None else self.search_params or {}).copy()
128
+ response = await self._async_scavio_client.google.search(query, **params)
129
+ return self._parse_response(response, self.top_k)
130
+
131
+ @staticmethod
132
+ def _parse_response(response: dict[str, Any], top_k: int | None) -> dict[str, Any]:
133
+ """
134
+ Convert a Scavio search response to Haystack Documents and links.
135
+
136
+ :param response: Scavio search response dictionary.
137
+ :param top_k: Maximum number of results to keep.
138
+ :returns: Dictionary with `documents` and `links` keys.
139
+ """
140
+ documents: list[Document] = []
141
+ links: list[str] = []
142
+
143
+ results = response.get("results", [])
144
+ if top_k is not None:
145
+ results = results[:top_k]
146
+
147
+ for result in results:
148
+ url = result.get("url", "")
149
+ title = result.get("title", "")
150
+ content = result.get("content", "")
151
+
152
+ documents.append(Document(content=content, meta={"title": title, "url": url}))
153
+ if url:
154
+ links.append(url)
155
+
156
+ return {"documents": documents, "links": links}
@@ -0,0 +1,3 @@
1
+ # SPDX-FileCopyrightText: 2026-present Scavio <scavio.dev@gmail.com>
2
+ #
3
+ # SPDX-License-Identifier: Apache-2.0
@@ -0,0 +1,199 @@
1
+ # SPDX-FileCopyrightText: 2026-present Scavio <scavio.dev@gmail.com>
2
+ #
3
+ # SPDX-License-Identifier: Apache-2.0
4
+
5
+ import os
6
+ from unittest.mock import AsyncMock, MagicMock, patch
7
+
8
+ import pytest
9
+ from haystack import Document
10
+ from haystack.core.serialization import component_from_dict, component_to_dict
11
+ from haystack.utils import Secret
12
+
13
+ from haystack_integrations.components.websearch.scavio import ScavioWebSearch
14
+
15
+
16
+ class TestScavioWebSearch:
17
+ @pytest.fixture
18
+ def search_response(self):
19
+ return {
20
+ "results": [
21
+ {"title": "Example Title", "url": "https://example.com", "content": "Example content", "position": 1}
22
+ ]
23
+ }
24
+
25
+ @pytest.fixture
26
+ def mock_client(self, search_response):
27
+ client = MagicMock()
28
+ client.google.search.return_value = search_response
29
+ return client
30
+
31
+ @pytest.fixture
32
+ def mock_async_client(self, search_response):
33
+ client = MagicMock()
34
+ client.google.search = AsyncMock(return_value=search_response)
35
+ return client
36
+
37
+ def test_init_default(self, monkeypatch):
38
+ monkeypatch.setenv("SCAVIO_API_KEY", "test-key")
39
+ ws = ScavioWebSearch()
40
+ assert ws.top_k == 10
41
+ assert ws.search_params is None
42
+ assert ws.api_key.resolve_value() == "test-key"
43
+
44
+ def test_init_with_params(self):
45
+ ws = ScavioWebSearch(
46
+ api_key=Secret.from_token("custom-key"),
47
+ top_k=5,
48
+ search_params={"country_code": "us"},
49
+ )
50
+ assert ws.top_k == 5
51
+ assert ws.search_params == {"country_code": "us"}
52
+
53
+ def test_to_dict(self, monkeypatch):
54
+ monkeypatch.setenv("SCAVIO_API_KEY", "test-key")
55
+ ws = ScavioWebSearch(top_k=5, search_params={"country_code": "us"})
56
+ data = component_to_dict(ws, "ScavioWebSearch")
57
+ assert data["type"] == "haystack_integrations.components.websearch.scavio.scavio_websearch.ScavioWebSearch"
58
+ assert data["init_parameters"]["top_k"] == 5
59
+ assert data["init_parameters"]["search_params"] == {"country_code": "us"}
60
+
61
+ def test_from_dict(self, monkeypatch):
62
+ monkeypatch.setenv("SCAVIO_API_KEY", "test-key")
63
+ data = {
64
+ "type": "haystack_integrations.components.websearch.scavio.scavio_websearch.ScavioWebSearch",
65
+ "init_parameters": {
66
+ "top_k": 3,
67
+ "search_params": {"language": "en"},
68
+ "api_key": {"env_vars": ["SCAVIO_API_KEY"], "strict": True, "type": "env_var"},
69
+ },
70
+ }
71
+ ws = component_from_dict(ScavioWebSearch, data, "ScavioWebSearch")
72
+ assert ws.top_k == 3
73
+ assert ws.search_params == {"language": "en"}
74
+
75
+ def test_run_returns_documents_and_links(self, mock_client):
76
+ ws = ScavioWebSearch(api_key=Secret.from_token("test-key"), top_k=10)
77
+ ws._scavio_client = mock_client
78
+
79
+ result = ws.run(query="test query")
80
+
81
+ assert len(result["documents"]) == 1
82
+ assert isinstance(result["documents"][0], Document)
83
+ assert result["documents"][0].content == "Example content"
84
+ assert result["documents"][0].meta["url"] == "https://example.com"
85
+ assert result["documents"][0].meta["title"] == "Example Title"
86
+ assert result["links"] == ["https://example.com"]
87
+ mock_client.google.search.assert_called_once_with("test query")
88
+
89
+ def test_run_overrides_params_at_runtime(self, mock_client):
90
+ ws = ScavioWebSearch(
91
+ api_key=Secret.from_token("test-key"),
92
+ top_k=10,
93
+ search_params={"country_code": "gb"},
94
+ )
95
+ ws._scavio_client = mock_client
96
+
97
+ ws.run(query="test", search_params={"country_code": "us"})
98
+
99
+ mock_client.google.search.assert_called_once_with("test", country_code="us")
100
+
101
+ def test_run_respects_top_k(self, mock_client):
102
+ mock_client.google.search.return_value = {
103
+ "results": [{"title": f"r{i}", "url": f"https://x/{i}", "content": "c"} for i in range(20)]
104
+ }
105
+ ws = ScavioWebSearch(api_key=Secret.from_token("test-key"), top_k=3)
106
+ ws._scavio_client = mock_client
107
+ result = ws.run(query="test")
108
+ assert len(result["documents"]) == 3
109
+ assert len(result["links"]) == 3
110
+
111
+ @pytest.mark.asyncio
112
+ async def test_run_async(self, mock_async_client):
113
+ ws = ScavioWebSearch(api_key=Secret.from_token("test-key"), top_k=10)
114
+ ws._async_scavio_client = mock_async_client
115
+
116
+ result = await ws.run_async(query="test query")
117
+
118
+ assert len(result["documents"]) == 1
119
+ assert result["links"] == ["https://example.com"]
120
+ mock_async_client.google.search.assert_awaited_once()
121
+
122
+ def test_run_raises_on_error(self, mock_client):
123
+ mock_client.google.search.side_effect = Exception("API error")
124
+ ws = ScavioWebSearch(api_key=Secret.from_token("test-key"))
125
+ ws._scavio_client = mock_client
126
+
127
+ with pytest.raises(Exception, match="API error"):
128
+ ws.run(query="test")
129
+
130
+ @pytest.mark.asyncio
131
+ async def test_run_async_raises_on_error(self, mock_async_client):
132
+ mock_async_client.google.search = AsyncMock(side_effect=Exception("API error"))
133
+ ws = ScavioWebSearch(api_key=Secret.from_token("test-key"))
134
+ ws._async_scavio_client = mock_async_client
135
+
136
+ with pytest.raises(Exception, match="API error"):
137
+ await ws.run_async(query="test")
138
+
139
+ def test_warm_up_initializes_clients(self):
140
+ ws = ScavioWebSearch(api_key=Secret.from_token("test-key"))
141
+ assert ws._scavio_client is None
142
+ assert ws._async_scavio_client is None
143
+ ws.warm_up()
144
+ assert ws._scavio_client is not None
145
+ assert ws._async_scavio_client is not None
146
+
147
+ def test_run_triggers_warm_up(self, search_response):
148
+ with (
149
+ patch("haystack_integrations.components.websearch.scavio.scavio_websearch.ScavioClient") as mock_cls,
150
+ patch("haystack_integrations.components.websearch.scavio.scavio_websearch.AsyncScavioClient"),
151
+ ):
152
+ mock_cls.return_value.google.search.return_value = search_response
153
+ ws = ScavioWebSearch(api_key=Secret.from_token("test-key"))
154
+ ws.run(query="test")
155
+ mock_cls.assert_called_once_with(api_key="test-key")
156
+
157
+ @pytest.mark.asyncio
158
+ async def test_run_async_triggers_warm_up(self, search_response):
159
+ with (
160
+ patch("haystack_integrations.components.websearch.scavio.scavio_websearch.ScavioClient"),
161
+ patch("haystack_integrations.components.websearch.scavio.scavio_websearch.AsyncScavioClient") as mock_cls,
162
+ ):
163
+ mock_cls.return_value.google.search = AsyncMock(return_value=search_response)
164
+ ws = ScavioWebSearch(api_key=Secret.from_token("test-key"))
165
+ await ws.run_async(query="test")
166
+ mock_cls.assert_called_once_with(api_key="test-key")
167
+
168
+ def test_run_empty_results(self, mock_client):
169
+ mock_client.google.search.return_value = {"results": []}
170
+ ws = ScavioWebSearch(api_key=Secret.from_token("test-key"))
171
+ ws._scavio_client = mock_client
172
+ result = ws.run(query="obscure query")
173
+ assert result["documents"] == []
174
+ assert result["links"] == []
175
+
176
+ def test_run_raises_runtime_error_when_warm_up_fails_to_initialize_client(self, monkeypatch):
177
+ ws = ScavioWebSearch(api_key=Secret.from_token("test-key"))
178
+ monkeypatch.setattr(ws, "warm_up", lambda: None)
179
+ with pytest.raises(RuntimeError, match="ScavioWebSearch client failed to initialize"):
180
+ ws.run(query="test")
181
+
182
+ @pytest.mark.asyncio
183
+ async def test_run_async_raises_runtime_error_when_warm_up_fails_to_initialize_client(self, monkeypatch):
184
+ ws = ScavioWebSearch(api_key=Secret.from_token("test-key"))
185
+ monkeypatch.setattr(ws, "warm_up", lambda: None)
186
+ with pytest.raises(RuntimeError, match="ScavioWebSearch async client failed to initialize"):
187
+ await ws.run_async(query="test")
188
+
189
+ @pytest.mark.skipif(
190
+ not os.environ.get("SCAVIO_API_KEY"),
191
+ reason="Export SCAVIO_API_KEY to run integration tests.",
192
+ )
193
+ @pytest.mark.integration
194
+ def test_run_integration(self):
195
+ ws = ScavioWebSearch(api_key=Secret.from_env_var("SCAVIO_API_KEY"), top_k=3)
196
+ result = ws.run(query="What is Haystack by deepset?")
197
+ assert len(result["documents"]) > 0
198
+ assert len(result["links"]) > 0
199
+ assert isinstance(result["documents"][0], Document)