scavio-haystack 0.1.0__py3-none-any.whl

haystack_integrations/components/websearch/scavio/__init__.py

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2026-present Scavio <scavio.dev@gmail.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from haystack_integrations.components.websearch.scavio.scavio_websearch import ScavioWebSearch
+
+__all__ = ["ScavioWebSearch"]

haystack_integrations/components/websearch/scavio/scavio_websearch.py

@@ -0,0 +1,156 @@
+# SPDX-FileCopyrightText: 2026-present Scavio <scavio.dev@gmail.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from typing import Any
+
+from haystack import Document, component, logging
+from haystack.utils import Secret
+
+from scavio import AsyncScavioClient, ScavioClient
+
+logger = logging.getLogger(__name__)
+
+
+@component
+class ScavioWebSearch:
+    """
+    A component that uses Scavio to search the web and return results as Haystack Documents.
+
+    This component wraps the Scavio Google web search endpoint, enabling real-time web search
+    queries that return structured documents with content and links.
+
+    Scavio is a unified search API for AI agents. You need a Scavio API key from
+    [dashboard.scavio.dev](https://dashboard.scavio.dev).
+
+    ### Usage example
+
+    ```python
+    from haystack_integrations.components.websearch.scavio import ScavioWebSearch
+    from haystack.utils import Secret
+
+    websearch = ScavioWebSearch(
+        api_key=Secret.from_env_var("SCAVIO_API_KEY"),
+        top_k=5,
+    )
+    result = websearch.run(query="What is Haystack by deepset?")
+    documents = result["documents"]
+    links = result["links"]
+    ```
+    """
+
+    def __init__(
+        self,
+        api_key: Secret = Secret.from_env_var("SCAVIO_API_KEY"),
+        top_k: int | None = 10,
+        search_params: dict[str, Any] | None = None,
+    ) -> None:
+        """
+        Initialize the ScavioWebSearch component.
+
+        :param api_key:
+            API key for Scavio. Defaults to the `SCAVIO_API_KEY` environment variable.
+        :param top_k:
+            Maximum number of results to return.
+        :param search_params:
+            Additional parameters passed to the Scavio Google search endpoint. Supported keys
+            include: `country_code`, `language`, `page`, `search_type`, `device`, `nfpr`,
+            `light_request`.
+        """
+        self.api_key = api_key
+        self.top_k = top_k
+        self.search_params = search_params
+        self._scavio_client: ScavioClient | None = None
+        self._async_scavio_client: AsyncScavioClient | None = None
+
+    def warm_up(self) -> None:
+        """
+        Initialize the Scavio sync and async clients.
+
+        Called automatically on first use. Can be called explicitly to avoid cold-start latency.
+        """
+        if self._scavio_client is None:
+            self._scavio_client = ScavioClient(api_key=self.api_key.resolve_value())
+        if self._async_scavio_client is None:
+            self._async_scavio_client = AsyncScavioClient(api_key=self.api_key.resolve_value())
+
+    @component.output_types(documents=list[Document], links=list[str])
+    def run(
+        self,
+        query: str,
+        search_params: dict[str, Any] | None = None,
+    ) -> dict[str, Any]:
+        """
+        Search the web using Scavio and return results as Documents.
+
+        :param query: Search query string.
+        :param search_params:
+            Optional per-run override of search parameters.
+            If provided, fully replaces the init-time `search_params`.
+        :returns: A dictionary with:
+            - `documents`: List of Documents containing search result content.
+            - `links`: List of URLs from the search results.
+        """
+        if self._scavio_client is None:
+            self.warm_up()
+        if self._scavio_client is None:
+            msg = "ScavioWebSearch client failed to initialize."
+            raise RuntimeError(msg)
+
+        params = (search_params if search_params is not None else self.search_params or {}).copy()
+        response = self._scavio_client.google.search(query, **params)
+        return self._parse_response(response, self.top_k)
+
+    @component.output_types(documents=list[Document], links=list[str])
+    async def run_async(
+        self,
+        query: str,
+        search_params: dict[str, Any] | None = None,
+    ) -> dict[str, Any]:
+        """
+        Asynchronously search the web using Scavio and return results as Documents.
+
+        :param query: Search query string.
+        :param search_params:
+            Optional per-run override of search parameters.
+            If provided, fully replaces the init-time `search_params`.
+        :returns: A dictionary with:
+            - `documents`: List of Documents containing search result content.
+            - `links`: List of URLs from the search results.
+        """
+        if self._async_scavio_client is None:
+            self.warm_up()
+        if self._async_scavio_client is None:
+            msg = "ScavioWebSearch async client failed to initialize."
+            raise RuntimeError(msg)
+
+        params = (search_params if search_params is not None else self.search_params or {}).copy()
+        response = await self._async_scavio_client.google.search(query, **params)
+        return self._parse_response(response, self.top_k)
+
+    @staticmethod
+    def _parse_response(response: dict[str, Any], top_k: int | None) -> dict[str, Any]:
+        """
+        Convert a Scavio search response to Haystack Documents and links.
+
+        :param response: Scavio search response dictionary.
+        :param top_k: Maximum number of results to keep.
+        :returns: Dictionary with `documents` and `links` keys.
+        """
+        documents: list[Document] = []
+        links: list[str] = []
+
+        results = response.get("results", [])
+        if top_k is not None:
+            results = results[:top_k]
+
+        for result in results:
+            url = result.get("url", "")
+            title = result.get("title", "")
+            content = result.get("content", "")
+
+            documents.append(Document(content=content, meta={"title": title, "url": url}))
+            if url:
+                links.append(url)
+
+        return {"documents": documents, "links": links}

scavio_haystack-0.1.0.dist-info/METADATA

@@ -0,0 +1,131 @@
+Metadata-Version: 2.4
+Name: scavio-haystack
+Version: 0.1.0
+Summary: Haystack integration for Scavio Web Search
+Project-URL: Documentation, https://github.com/scavio-ai/haystack-scavio#readme
+Project-URL: Issues, https://github.com/scavio-ai/haystack-scavio/issues
+Project-URL: Source, https://github.com/scavio-ai/haystack-scavio
+Author-email: Scavio <scavio.dev@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: AI Search,Haystack,Scavio,Web Search
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.10
+Requires-Dist: haystack-ai>=2.24.1
+Requires-Dist: scavio>=0.2.1
+Description-Content-Type: text/markdown
+
+# scavio-haystack
+
+[![PyPI - Version](https://img.shields.io/pypi/v/scavio-haystack.svg)](https://pypi.org/project/scavio-haystack)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/scavio-haystack.svg)](https://pypi.org/project/scavio-haystack)
+
+[Scavio](https://scavio.dev) integration for [Haystack](https://haystack.deepset.ai) by deepset.
+
+Provides `ScavioWebSearch`, a web search component backed by the Scavio API. It returns results
+as Haystack `Document` objects (with title and URL metadata) plus the list of source links, and
+mirrors the existing `TavilyWebSearch` / `ExaWebSearch` components.
+
+Scavio is a unified search API for AI agents. Get an API key at
+[dashboard.scavio.dev](https://dashboard.scavio.dev).
+
+## Installation
+
+```bash
+pip install scavio-haystack
+```
+
+## Usage
+
+```python
+from haystack_integrations.components.websearch.scavio import ScavioWebSearch
+from haystack.utils import Secret
+
+web_search = ScavioWebSearch(
+    api_key=Secret.from_env_var("SCAVIO_API_KEY"),  # defaults to SCAVIO_API_KEY
+    top_k=5,
+)
+
+result = web_search.run(query="What is Haystack by deepset?")
+documents = result["documents"]
+links = result["links"]
+```
+
+### In a pipeline
+
+```python
+from haystack import Pipeline
+from haystack.components.builders import PromptBuilder
+from haystack.components.generators import OpenAIGenerator
+from haystack_integrations.components.websearch.scavio import ScavioWebSearch
+
+template = """
+Given the following web search results, answer the question.
+
+Results:
+{% for doc in documents %}{{ doc.content }}
+{% endfor %}
+
+Question: {{ query }}
+Answer:
+"""
+
+pipe = Pipeline()
+pipe.add_component("search", ScavioWebSearch(top_k=5))
+pipe.add_component("prompt_builder", PromptBuilder(template=template))
+pipe.add_component("llm", OpenAIGenerator())
+pipe.connect("search.documents", "prompt_builder.documents")
+pipe.connect("prompt_builder", "llm")
+
+query = "What is Haystack by deepset?"
+result = pipe.run(data={"search": {"query": query}, "prompt_builder": {"query": query}})
+print(result["llm"]["replies"][0])
+```
+
+### Async support
+
+```python
+import asyncio
+from haystack_integrations.components.websearch.scavio import ScavioWebSearch
+
+async def main():
+    web_search = ScavioWebSearch(top_k=3)
+    result = await web_search.run_async(query="What is Haystack by deepset?")
+    print(f"Found {len(result['documents'])} documents")
+
+asyncio.run(main())
+```
+
+## Parameters
+
+- **`api_key`**: API key for Scavio. Defaults to the `SCAVIO_API_KEY` environment variable.
+- **`top_k`**: Maximum number of results to return. Defaults to 10.
+- **`search_params`**: Additional parameters passed to the Scavio Google search endpoint.
+  Supported keys include `country_code`, `language`, `page`, `search_type`, `device`, `nfpr`,
+  `light_request`. Can be set at init time or overridden per `run`.
+
+## Development
+
+This project uses [Hatch](https://hatch.pypa.io/).
+
+```bash
+pip install hatch
+
+hatch run fmt-check     # lint + format check
+hatch run test:unit     # unit tests
+hatch run test:all      # all tests (set SCAVIO_API_KEY for integration tests)
+```
+
+## License
+
+`scavio-haystack` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.

scavio_haystack-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+haystack_integrations/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+haystack_integrations/components/websearch/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+haystack_integrations/components/websearch/scavio/__init__.py,sha256=CoXqMpgFeChGhDKq8aSVTQ4yw-aum1LWJ6ZA5W9kjf8,236
+haystack_integrations/components/websearch/scavio/scavio_websearch.py,sha256=029a7Jt7tscVMdBhEqNtjvEJ37a-i9jjbUhHOxh7o94,5772
+scavio_haystack-0.1.0.dist-info/METADATA,sha256=f8wBIqzUL7xr-I2EH4TZYydSrdjy9VQSqOvsRcq6rC8,4428
+scavio_haystack-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+scavio_haystack-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+scavio_haystack-0.1.0.dist-info/RECORD,,

scavio_haystack-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

scavio_haystack-0.1.0.dist-info/licenses/LICENSE

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