serpex-haystack 1.0.0__tar.gz

serpex_haystack-1.0.0/.gitignore

@@ -0,0 +1,56 @@
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+venv/
+ENV/
+env/
+.venv
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Environment variables
+.env
+.env.local
+
+# OS
+.DS_Store
+Thumbs.db

serpex_haystack-1.0.0/LICENSE

@@ -0,0 +1,176 @@
+                                 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 Support. 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

serpex_haystack-1.0.0/PKG-INFO

@@ -0,0 +1,285 @@
+Metadata-Version: 2.4
+Name: serpex-haystack
+Version: 1.0.0
+Summary: Haystack integration for Serpex web search - supporting Google, Bing, DuckDuckGo, Brave, Yahoo, and Yandex
+Project-URL: Homepage, https://serpex.dev
+Project-URL: Documentation, https://docs.serpex.dev
+Project-URL: Repository, https://github.com/divyeshradadiya/serpex-haystack
+Project-URL: Issues, https://github.com/divyeshradadiya/serpex-haystack/issues
+Author-email: Divyesh Radadiya <divyeshradadiya0@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai,bing-search,duckduckgo,google-search,haystack,llm,nlp,search-api,serpex,web-search
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.8
+Requires-Dist: haystack-ai>=2.0.0
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: tenacity>=8.0.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Serpex Haystack Integration
+
+[![PyPI - Version](https://img.shields.io/pypi/v/serpex-haystack.svg)](https://pypi.org/project/serpex-haystack)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/serpex-haystack.svg)](https://pypi.org/project/serpex-haystack)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![CI Tests](https://github.com/divyeshradadiya/serpex-haystack/actions/workflows/ci.yml/badge.svg)](https://github.com/divyeshradadiya/serpex-haystack/actions/workflows/ci.yml)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+[Serpex](https://serpex.dev) integration for [Haystack](https://haystack.deepset.ai/) - bringing powerful multi-engine web search capabilities to your Haystack pipelines.
+
+## Overview
+
+Serpex is a unified web search API that provides access to multiple search engines including Google, Bing, DuckDuckGo, Brave, Yahoo, and Yandex. This integration allows you to seamlessly incorporate web search results into your Haystack RAG (Retrieval-Augmented Generation) pipelines and AI applications.
+
+### Key Features
+
+- 🔍 **Multi-Engine Support**: Switch between Google, Bing, DuckDuckGo, Brave, Yahoo, and Yandex
+- ⚡ **High Performance**: Fast and reliable API with automatic retries
+- 🎯 **Rich Results**: Get organic search results with titles, snippets, and URLs
+- 🕒 **Time Filters**: Filter results by day, week, month, or year
+- 🔒 **Type-Safe**: Fully typed with comprehensive type hints
+- 📝 **Haystack Native**: Seamless integration with Haystack 2.0+ components
+
+## Installation
+
+```bash
+pip install serpex-haystack
+```
+
+## Quick Start
+
+### Get Your API Key
+
+Sign up at [Serpex.dev](https://serpex.dev) to get your free API key.
+
+### Basic Usage
+
+```python
+from haystack import Pipeline
+from haystack.components.builders import PromptBuilder
+from haystack.components.generators import OpenAIGenerator
+from haystack.utils import Secret
+from haystack_integrations.components.websearch.serpex import SerpexWebSearch
+
+# Create a web search component
+web_search = SerpexWebSearch(
+    api_key=Secret.from_env_var("SERPEX_API_KEY"),
+    engine="google",  # or "bing", "duckduckgo", "brave", "yahoo", "yandex"
+)
+
+# Use it standalone
+results = web_search.run(query="What is Haystack AI?")
+for doc in results["documents"]:
+    print(f"Title: {doc.meta['title']}")
+    print(f"URL: {doc.meta['url']}")
+    print(f"Snippet: {doc.content}\n")
+```
+
+### RAG Pipeline Example
+
+```python
+from haystack import Pipeline
+from haystack.components.builders import PromptBuilder
+from haystack.components.generators import OpenAIGenerator
+from haystack.utils import Secret
+from haystack_integrations.components.websearch.serpex import SerpexWebSearch
+
+# Create a simple RAG pipeline with web search
+prompt_template = """
+Based on the following search results, answer the question.
+
+Search Results:
+{% for doc in documents %}
+- {{ doc.meta.title }}: {{ doc.content }}
+  Source: {{ doc.meta.url }}
+{% endfor %}
+
+Question: {{ query }}
+
+Answer:
+"""
+
+pipe = Pipeline()
+pipe.add_component("search", SerpexWebSearch(api_key=Secret.from_env_var("SERPEX_API_KEY")))
+pipe.add_component("prompt", PromptBuilder(template=prompt_template))
+pipe.add_component("llm", OpenAIGenerator(api_key=Secret.from_env_var("OPENAI_API_KEY")))
+
+pipe.connect("search.documents", "prompt.documents")
+pipe.connect("prompt", "llm")
+
+# Run the pipeline
+result = pipe.run({
+    "search": {"query": "Latest developments in AI agents"},
+    "prompt": {"query": "Latest developments in AI agents"}
+})
+
+print(result["llm"]["replies"][0])
+```
+
+## Advanced Features
+
+### Multiple Search Engines
+
+```python
+# Use different engines for different queries
+google_search = SerpexWebSearch(engine="google")
+bing_search = SerpexWebSearch(engine="bing")
+duckduckgo_search = SerpexWebSearch(engine="duckduckgo")
+```
+
+### Time Range Filtering
+
+```python
+# Get only recent results
+recent_results = web_search.run(
+    query="AI news",
+    time_range="week"  # Options: "day", "week", "month", "year", "all"
+)
+```
+
+### Runtime Configuration Override
+
+```python
+# Override settings at runtime
+results = web_search.run(
+    query="Python tutorials",
+    engine="duckduckgo",  # Override default engine
+)
+```
+
+### Error Handling with Retries
+
+The component includes built-in retry logic with exponential backoff:
+
+```python
+web_search = SerpexWebSearch(
+    api_key=Secret.from_env_var("SERPEX_API_KEY"),
+    timeout=10.0,  # Request timeout in seconds
+    retry_attempts=3  # Number of retry attempts
+)
+```
+
+## Component Reference
+
+### SerpexWebSearch
+
+A Haystack component for fetching web search results via the Serpex API.
+
+#### Parameters
+
+- **api_key** (`Secret`, optional): Serpex API key. Defaults to `SERPEX_API_KEY` environment variable.
+- **engine** (`str`, optional): Search engine to use. Options: `"auto"`, `"google"`, `"bing"`, `"duckduckgo"`, `"brave"`, `"yahoo"`, `"yandex"`. Defaults to `"google"`.
+- **timeout** (`float`, optional): Request timeout in seconds. Defaults to `10.0`.
+- **retry_attempts** (`int`, optional): Number of retry attempts. Defaults to `2`.
+
+#### Inputs
+
+- **query** (`str`): The search query string.
+- **engine** (`str`, optional): Override the default search engine.
+- **time_range** (`str`, optional): Filter by time range (`"all"`, `"day"`, `"week"`, `"month"`, `"year"`).
+
+#### Outputs
+
+- **documents** (`List[Document]`): List of Haystack Document objects containing search results.
+
+Each document includes:
+- **content**: The search result snippet
+- **meta**:
+  - `title`: Result title
+  - `url`: Result URL
+  - `position`: Position in search results
+  - `query`: Original search query
+  - `engine`: Search engine used
+
+## Examples
+
+Check out the [examples](examples/) directory for more use cases:
+
+- [Basic Search](examples/basic_search.py)
+- [RAG Pipeline](examples/rag_pipeline.py)
+- [Multi-Engine Comparison](examples/multi_engine.py)
+- [Agent with Web Search](examples/agent_example.py)
+
+## Why Serpex?
+
+- **🌐 Multi-Engine Access**: One API for all major search engines
+- **⚡ Fast & Reliable**: Optimized infrastructure with 99.9% uptime
+- **💰 Cost-Effective**: Competitive pricing with generous free tier
+- **📊 Rich Metadata**: Comprehensive result data including positions, timestamps, and more
+- **🔒 Secure**: Enterprise-grade security and data privacy
+- **🚀 Scalable**: Handle thousands of requests per second
+
+## Documentation
+
+- [Serpex API Documentation](https://docs.serpex.dev)
+- [Haystack Documentation](https://docs.haystack.deepset.ai)
+- [Integration Examples](examples/)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/divyeshradadiya/serpex-haystack.git
+cd serpex-haystack
+
+# Install with development dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run linting
+ruff check .
+black --check .
+
+# Run type checking
+mypy src/
+```
+
+## License
+
+This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+- 📧 Email: support@serpex.dev
+- 💬 Discord: [Join our community](https://discord.com/channels/1417759329385316383/1421004675343319102)
+- 🐛 Issues: [GitHub Issues](https://github.com/divyeshradadiya/serpex-haystack/issues)
+- 📖 Docs: [docs.serpex.dev](https://serpex.dev/docs)
+
+## Acknowledgments
+
+Built with ❤️ for the Haystack community by [Divyesh Radadiya](https://github.com/divyeshradadiya)
+
+---
+
+**Note**: This is a community-maintained integration. For Serpex API support, visit [serpex.dev](https://serpex.dev).

serpex_haystack-1.0.0/README.md

@@ -0,0 +1,247 @@
+# Serpex Haystack Integration
+
+[![PyPI - Version](https://img.shields.io/pypi/v/serpex-haystack.svg)](https://pypi.org/project/serpex-haystack)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/serpex-haystack.svg)](https://pypi.org/project/serpex-haystack)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![CI Tests](https://github.com/divyeshradadiya/serpex-haystack/actions/workflows/ci.yml/badge.svg)](https://github.com/divyeshradadiya/serpex-haystack/actions/workflows/ci.yml)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+[Serpex](https://serpex.dev) integration for [Haystack](https://haystack.deepset.ai/) - bringing powerful multi-engine web search capabilities to your Haystack pipelines.
+
+## Overview
+
+Serpex is a unified web search API that provides access to multiple search engines including Google, Bing, DuckDuckGo, Brave, Yahoo, and Yandex. This integration allows you to seamlessly incorporate web search results into your Haystack RAG (Retrieval-Augmented Generation) pipelines and AI applications.
+
+### Key Features
+
+- 🔍 **Multi-Engine Support**: Switch between Google, Bing, DuckDuckGo, Brave, Yahoo, and Yandex
+- ⚡ **High Performance**: Fast and reliable API with automatic retries
+- 🎯 **Rich Results**: Get organic search results with titles, snippets, and URLs
+- 🕒 **Time Filters**: Filter results by day, week, month, or year
+- 🔒 **Type-Safe**: Fully typed with comprehensive type hints
+- 📝 **Haystack Native**: Seamless integration with Haystack 2.0+ components
+
+## Installation
+
+```bash
+pip install serpex-haystack
+```
+
+## Quick Start
+
+### Get Your API Key
+
+Sign up at [Serpex.dev](https://serpex.dev) to get your free API key.
+
+### Basic Usage
+
+```python
+from haystack import Pipeline
+from haystack.components.builders import PromptBuilder
+from haystack.components.generators import OpenAIGenerator
+from haystack.utils import Secret
+from haystack_integrations.components.websearch.serpex import SerpexWebSearch
+
+# Create a web search component
+web_search = SerpexWebSearch(
+    api_key=Secret.from_env_var("SERPEX_API_KEY"),
+    engine="google",  # or "bing", "duckduckgo", "brave", "yahoo", "yandex"
+)
+
+# Use it standalone
+results = web_search.run(query="What is Haystack AI?")
+for doc in results["documents"]:
+    print(f"Title: {doc.meta['title']}")
+    print(f"URL: {doc.meta['url']}")
+    print(f"Snippet: {doc.content}\n")
+```
+
+### RAG Pipeline Example
+
+```python
+from haystack import Pipeline
+from haystack.components.builders import PromptBuilder
+from haystack.components.generators import OpenAIGenerator
+from haystack.utils import Secret
+from haystack_integrations.components.websearch.serpex import SerpexWebSearch
+
+# Create a simple RAG pipeline with web search
+prompt_template = """
+Based on the following search results, answer the question.
+
+Search Results:
+{% for doc in documents %}
+- {{ doc.meta.title }}: {{ doc.content }}
+  Source: {{ doc.meta.url }}
+{% endfor %}
+
+Question: {{ query }}
+
+Answer:
+"""
+
+pipe = Pipeline()
+pipe.add_component("search", SerpexWebSearch(api_key=Secret.from_env_var("SERPEX_API_KEY")))
+pipe.add_component("prompt", PromptBuilder(template=prompt_template))
+pipe.add_component("llm", OpenAIGenerator(api_key=Secret.from_env_var("OPENAI_API_KEY")))
+
+pipe.connect("search.documents", "prompt.documents")
+pipe.connect("prompt", "llm")
+
+# Run the pipeline
+result = pipe.run({
+    "search": {"query": "Latest developments in AI agents"},
+    "prompt": {"query": "Latest developments in AI agents"}
+})
+
+print(result["llm"]["replies"][0])
+```
+
+## Advanced Features
+
+### Multiple Search Engines
+
+```python
+# Use different engines for different queries
+google_search = SerpexWebSearch(engine="google")
+bing_search = SerpexWebSearch(engine="bing")
+duckduckgo_search = SerpexWebSearch(engine="duckduckgo")
+```
+
+### Time Range Filtering
+
+```python
+# Get only recent results
+recent_results = web_search.run(
+    query="AI news",
+    time_range="week"  # Options: "day", "week", "month", "year", "all"
+)
+```
+
+### Runtime Configuration Override
+
+```python
+# Override settings at runtime
+results = web_search.run(
+    query="Python tutorials",
+    engine="duckduckgo",  # Override default engine
+)
+```
+
+### Error Handling with Retries
+
+The component includes built-in retry logic with exponential backoff:
+
+```python
+web_search = SerpexWebSearch(
+    api_key=Secret.from_env_var("SERPEX_API_KEY"),
+    timeout=10.0,  # Request timeout in seconds
+    retry_attempts=3  # Number of retry attempts
+)
+```
+
+## Component Reference
+
+### SerpexWebSearch
+
+A Haystack component for fetching web search results via the Serpex API.
+
+#### Parameters
+
+- **api_key** (`Secret`, optional): Serpex API key. Defaults to `SERPEX_API_KEY` environment variable.
+- **engine** (`str`, optional): Search engine to use. Options: `"auto"`, `"google"`, `"bing"`, `"duckduckgo"`, `"brave"`, `"yahoo"`, `"yandex"`. Defaults to `"google"`.
+- **timeout** (`float`, optional): Request timeout in seconds. Defaults to `10.0`.
+- **retry_attempts** (`int`, optional): Number of retry attempts. Defaults to `2`.
+
+#### Inputs
+
+- **query** (`str`): The search query string.
+- **engine** (`str`, optional): Override the default search engine.
+- **time_range** (`str`, optional): Filter by time range (`"all"`, `"day"`, `"week"`, `"month"`, `"year"`).
+
+#### Outputs
+
+- **documents** (`List[Document]`): List of Haystack Document objects containing search results.
+
+Each document includes:
+- **content**: The search result snippet
+- **meta**:
+  - `title`: Result title
+  - `url`: Result URL
+  - `position`: Position in search results
+  - `query`: Original search query
+  - `engine`: Search engine used
+
+## Examples
+
+Check out the [examples](examples/) directory for more use cases:
+
+- [Basic Search](examples/basic_search.py)
+- [RAG Pipeline](examples/rag_pipeline.py)
+- [Multi-Engine Comparison](examples/multi_engine.py)
+- [Agent with Web Search](examples/agent_example.py)
+
+## Why Serpex?
+
+- **🌐 Multi-Engine Access**: One API for all major search engines
+- **⚡ Fast & Reliable**: Optimized infrastructure with 99.9% uptime
+- **💰 Cost-Effective**: Competitive pricing with generous free tier
+- **📊 Rich Metadata**: Comprehensive result data including positions, timestamps, and more
+- **🔒 Secure**: Enterprise-grade security and data privacy
+- **🚀 Scalable**: Handle thousands of requests per second
+
+## Documentation
+
+- [Serpex API Documentation](https://docs.serpex.dev)
+- [Haystack Documentation](https://docs.haystack.deepset.ai)
+- [Integration Examples](examples/)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/divyeshradadiya/serpex-haystack.git
+cd serpex-haystack
+
+# Install with development dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run linting
+ruff check .
+black --check .
+
+# Run type checking
+mypy src/
+```
+
+## License
+
+This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+- 📧 Email: support@serpex.dev
+- 💬 Discord: [Join our community](https://discord.com/channels/1417759329385316383/1421004675343319102)
+- 🐛 Issues: [GitHub Issues](https://github.com/divyeshradadiya/serpex-haystack/issues)
+- 📖 Docs: [docs.serpex.dev](https://serpex.dev/docs)
+
+## Acknowledgments
+
+Built with ❤️ for the Haystack community by [Divyesh Radadiya](https://github.com/divyeshradadiya)
+
+---
+
+**Note**: This is a community-maintained integration. For Serpex API support, visit [serpex.dev](https://serpex.dev).

serpex_haystack-1.0.0/pyproject.toml

@@ -0,0 +1,120 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "serpex-haystack"
+version = "1.0.0"
+description = "Haystack integration for Serpex web search - supporting Google, Bing, DuckDuckGo, Brave, Yahoo, and Yandex"
+readme = "README.md"
+requires-python = ">=3.8"
+license = "Apache-2.0"
+keywords = [
+    "haystack",
+    "serpex",
+    "web-search",
+    "search-api",
+    "google-search",
+    "bing-search",
+    "duckduckgo",
+    "nlp",
+    "ai",
+    "llm",
+]
+authors = [
+    { name = "Divyesh Radadiya", email = "divyeshradadiya0@gmail.com" },
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Internet :: WWW/HTTP :: Indexing/Search",
+]
+
+dependencies = [
+    "haystack-ai>=2.0.0",
+    "httpx>=0.24.0",
+    "tenacity>=8.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "pytest-asyncio>=0.21.0",
+    "black>=23.0.0",
+    "ruff>=0.1.0",
+    "mypy>=1.0.0",
+    "pre-commit>=3.0.0",
+]
+
+[project.urls]
+Homepage = "https://serpex.dev"
+Documentation = "https://docs.serpex.dev"
+Repository = "https://github.com/divyeshradadiya/serpex-haystack"
+Issues = "https://github.com/divyeshradadiya/serpex-haystack/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/haystack_integrations"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/tests",
+    "/README.md",
+    "/LICENSE",
+]
+
+[tool.black]
+line-length = 120
+target-version = ["py38"]
+
+[tool.ruff]
+line-length = 120
+target-version = "py38"
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "C",  # flake8-comprehensions
+    "B",  # flake8-bugbear
+]
+ignore = [
+    "E501",  # line too long (handled by black)
+    "B008",  # do not perform function calls in argument defaults
+]
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+warn_unused_configs = true
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+minversion = "7.0"
+addopts = "-v --cov=src/haystack_integrations --cov-report=term-missing --cov-report=html"
+testpaths = ["tests"]
+
+[tool.coverage.run]
+source = ["src/haystack_integrations"]
+omit = ["*/tests/*"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+]

serpex_haystack-1.0.0/src/haystack_integrations/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024-present Divyesh Radadiya <divyeshradadiya0@gmail.com>
+#
+# SPDX-License-Identifier: Apache-2.0

serpex_haystack-1.0.0/src/haystack_integrations/components/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024-present Divyesh Radadiya <divyeshradadiya0@gmail.com>
+#
+# SPDX-License-Identifier: Apache-2.0

serpex_haystack-1.0.0/src/haystack_integrations/components/websearch/__init__.py

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2024-present Divyesh Radadiya <divyeshradadiya0@gmail.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from haystack_integrations.components.websearch.serpex import SerpexWebSearch
+
+__all__ = ["SerpexWebSearch"]

serpex_haystack-1.0.0/src/haystack_integrations/components/websearch/serpex.py

@@ -0,0 +1,209 @@
+# SPDX-FileCopyrightText: 2024-present Divyesh Radadiya <divyeshradadiya0@gmail.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from typing import Any, Dict, List, Literal, Optional, cast
+
+import httpx
+from haystack import component, default_from_dict, default_to_dict, logging
+from haystack.dataclasses import Document
+from haystack.utils import Secret, deserialize_secrets_inplace
+from tenacity import retry, retry_if_exception_type, stop_after_attempt, wait_exponential
+
+logger = logging.getLogger(__name__)
+
+
+@component
+class SerpexWebSearch:
+    """
+    Fetches web search results from the Serpex API.
+
+    Serpex provides web search results from multiple search engines including Google, Bing, DuckDuckGo, and more.
+    Use it to retrieve organic search results, snippets, and metadata for search queries.
+
+    ### Usage example
+
+    ```python
+    from haystack_integrations.components.websearch.serpex import SerpexWebSearch
+    from haystack.utils import Secret
+
+    fetcher = SerpexWebSearch(api_key=Secret.from_token("your-serpex-api-key"))
+    results = fetcher.run(query="What is Haystack?")
+
+    documents = results["documents"]
+    for doc in documents:
+        print(f"Title: {doc.meta['title']}")
+        print(f"URL: {doc.meta['url']}")
+        print(f"Snippet: {doc.content}")
+    ```
+    """
+
+    def __init__(
+        self,
+        *,
+        api_key: Secret = Secret.from_env_var("SERPEX_API_KEY"),
+        engine: Literal["auto", "google", "bing", "duckduckgo", "brave", "yahoo", "yandex"] = "google",
+        timeout: float = 10.0,
+        retry_attempts: int = 2,
+    ) -> None:
+        """
+        Initializes the SerpexWebSearch component.
+
+        :param api_key: Serpex API key for authentication. Get yours at https://serpex.dev
+        :param engine: Search engine to use. Options: "auto", "google", "bing", "duckduckgo",
+                      "brave", "yahoo", "yandex". Defaults to "google".
+        :param timeout: Timeout in seconds for the API request. Defaults to 10.0.
+        :param retry_attempts: Number of retry attempts for failed requests. Defaults to 2.
+        """
+        self.api_key = api_key
+        self.engine = engine
+        self.timeout = timeout
+        self.retry_attempts = retry_attempts
+
+        # Create httpx client
+        self._client = httpx.Client(timeout=timeout, follow_redirects=True)
+
+        # Define retry decorator
+        @retry(
+            reraise=True,
+            stop=stop_after_attempt(self.retry_attempts),
+            wait=wait_exponential(multiplier=1, min=2, max=10),
+            retry=retry_if_exception_type((httpx.HTTPStatusError, httpx.RequestError)),
+        )
+        def make_request(url: str, headers: Dict[str, str], params: Dict[str, Any]) -> httpx.Response:
+            response = self._client.get(url, headers=headers, params=params)
+            response.raise_for_status()
+            return response
+
+        self._make_request = make_request
+
+    def __del__(self):
+        """
+        Clean up resources when the component is deleted.
+
+        Closes the HTTP client to prevent resource leaks.
+        """
+        try:
+            if hasattr(self, "_client"):
+                self._client.close()
+        except Exception:
+            pass
+
+    def to_dict(self) -> Dict[str, Any]:
+        """
+        Serializes the component to a dictionary.
+
+        :returns: Dictionary with serialized data.
+        """
+        return cast(
+            Dict[str, Any],
+            default_to_dict(
+                self,
+                api_key=self.api_key.to_dict(),
+                engine=self.engine,
+                timeout=self.timeout,
+                retry_attempts=self.retry_attempts,
+            ),
+        )
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "SerpexWebSearch":
+        """
+        Deserializes the component from a dictionary.
+
+        :param data: Dictionary to deserialize from.
+        :returns: Deserialized component.
+        """
+        deserialize_secrets_inplace(data["init_parameters"], keys=["api_key"])
+        return cast("SerpexWebSearch", default_from_dict(cls, data))
+
+    @component.output_types(documents=List[Document])
+    def run(
+        self,
+        query: str,
+        *,
+        engine: Optional[Literal["auto", "google", "bing", "duckduckgo", "brave", "yahoo", "yandex"]] = None,
+        time_range: Optional[Literal["all", "day", "week", "month", "year"]] = None,
+    ) -> Dict[str, List[Document]]:
+        """
+        Fetches web search results for the given query.
+
+        :param query: The search query string.
+        :param engine: Override the default search engine. If None, uses the engine from initialization.
+        :param time_range: Time range filter for results. Options: "all", "day", "week", "month", "year".
+                          Defaults to None (all time).
+        :returns: Dictionary containing a list of Document objects with search results.
+        """
+        documents: List[Document] = []
+
+        try:
+            # Prepare request parameters
+            params: Dict[str, Any] = {
+                "q": query,
+                "engine": engine or self.engine,
+                "category": "web",
+            }
+
+            if time_range:
+                params["time_range"] = time_range
+
+            headers = {
+                "Authorization": f"Bearer {self.api_key.resolve_value()}",
+                "Content-Type": "application/json",
+            }
+
+            # Make API request
+            response = self._make_request("https://api.serpex.dev/api/search", headers, params)
+            data = response.json()
+
+            # Parse search results
+            if "results" in data and isinstance(data["results"], list):
+                for result in data["results"]:
+                    # Extract result data
+                    title = result.get("title", "")
+                    url = result.get("url", "")  # API uses 'url' not 'link'
+                    snippet = result.get("snippet", "")
+                    position = result.get("position", 0)
+
+                    # Create Document object
+                    doc = Document(
+                        content=snippet,
+                        meta={
+                            "title": title,
+                            "url": url,
+                            "position": position,
+                            "query": query,
+                            "engine": engine or self.engine,
+                        },
+                    )
+                    documents.append(doc)
+
+                logger.info(
+                    "Successfully fetched {count} search results for query: {query}",
+                    count=len(documents),
+                    query=query,
+                )
+            else:
+                logger.warning(
+                    "No results found in Serpex API response for query: {query}",
+                    query=query,
+                )
+
+        except httpx.HTTPStatusError as e:
+            logger.error(
+                "HTTP error occurred while fetching Serpex results: {status} - {detail}",
+                status=e.response.status_code,
+                detail=str(e),
+            )
+            raise
+        except httpx.RequestError as e:
+            logger.error("Request error occurred while fetching Serpex results: {error}", error=e)
+            raise
+        except Exception as e:
+            logger.error(
+                "Unexpected error occurred while fetching Serpex results: {error}",
+                error=e,
+            )
+            raise
+
+        return {"documents": documents}

serpex_haystack-1.0.0/tests/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024-present Divyesh Radadiya <divyeshradadiya0@gmail.com>
+#
+# SPDX-License-Identifier: Apache-2.0

serpex_haystack-1.0.0/tests/test_serpex.py

@@ -0,0 +1,148 @@
+"""
+Tests for SerpexWebSearch component
+"""
+
+import os
+from unittest.mock import Mock, patch
+
+from haystack.dataclasses import Document
+from haystack.utils import Secret
+
+from haystack_integrations.components.websearch.serpex import SerpexWebSearch
+
+
+class TestSerpexWebSearch:
+    def test_init_default(self):
+        """Test initialization with default parameters"""
+        with patch.dict(os.environ, {"SERPEX_API_KEY": "test_key"}):
+            component = SerpexWebSearch()
+            assert component.engine == "google"
+            assert component.timeout == 10.0
+            assert component.retry_attempts == 2
+
+    def test_init_custom(self):
+        """Test initialization with custom parameters"""
+        component = SerpexWebSearch(
+            api_key=Secret.from_token("custom_key"),
+            engine="bing",
+            timeout=15.0,
+            retry_attempts=3,
+        )
+        assert component.engine == "bing"
+        assert component.timeout == 15.0
+        assert component.retry_attempts == 3
+
+    def test_to_dict(self):
+        """Test serialization to dictionary"""
+        with patch.dict(os.environ, {"SERPEX_API_KEY": "test_key"}):
+            component = SerpexWebSearch(
+                api_key=Secret.from_env_var("SERPEX_API_KEY"),
+                engine="duckduckgo",
+            )
+            data = component.to_dict()
+
+            assert data["type"] == "haystack_integrations.components.websearch.serpex.SerpexWebSearch"
+            assert data["init_parameters"]["engine"] == "duckduckgo"
+
+    def test_from_dict(self):
+        """Test deserialization from dictionary"""
+        data = {
+            "type": "haystack_integrations.components.websearch.serpex.SerpexWebSearch",
+            "init_parameters": {
+                "api_key": {"type": "env_var", "env_vars": ["SERPEX_API_KEY"], "strict": True},
+                "engine": "brave",
+                "timeout": 20.0,
+                "retry_attempts": 4,
+            },
+        }
+
+        with patch.dict(os.environ, {"SERPEX_API_KEY": "test_key"}):
+            component = SerpexWebSearch.from_dict(data)
+            assert component.engine == "brave"
+            assert component.timeout == 20.0
+            assert component.retry_attempts == 4
+
+    @patch("haystack_integrations.components.websearch.serpex.httpx.Client")
+    def test_run_success(self, mock_client):
+        """Test successful search"""
+        # Mock response
+        mock_response = Mock()
+        mock_response.json.return_value = {
+            "results": [
+                {
+                    "title": "Test Title 1",
+                    "url": "https://example.com/1",
+                    "snippet": "Test snippet 1",
+                    "position": 1,
+                },
+                {
+                    "title": "Test Title 2",
+                    "url": "https://example.com/2",
+                    "snippet": "Test snippet 2",
+                    "position": 2,
+                },
+            ]
+        }
+
+        # Setup mock client
+        mock_instance = Mock()
+        mock_instance.get.return_value = mock_response
+        mock_client.return_value = mock_instance
+
+        component = SerpexWebSearch(api_key=Secret.from_token("test_key"))
+        result = component.run(query="test query")
+
+        assert "documents" in result
+        assert len(result["documents"]) == 2
+
+        doc1 = result["documents"][0]
+        assert isinstance(doc1, Document)
+        assert doc1.content == "Test snippet 1"
+        assert doc1.meta["title"] == "Test Title 1"
+        assert doc1.meta["url"] == "https://example.com/1"
+        assert doc1.meta["position"] == 1
+        assert doc1.meta["query"] == "test query"
+
+    @patch("haystack_integrations.components.websearch.serpex.httpx.Client")
+    def test_run_with_overrides(self, mock_client):
+        """Test search with runtime parameter overrides"""
+        mock_response = Mock()
+        mock_response.json.return_value = {"results": []}
+
+        mock_instance = Mock()
+        mock_instance.get.return_value = mock_response
+        mock_client.return_value = mock_instance
+
+        component = SerpexWebSearch(api_key=Secret.from_token("test_key"))
+        component.run(query="test", engine="bing", time_range="week")
+
+        # Check that parameters were passed correctly
+        call_args = mock_instance.get.call_args
+        params = call_args[1]["params"]
+        assert params["engine"] == "bing"
+        assert params["time_range"] == "week"
+
+    @patch("haystack_integrations.components.websearch.serpex.httpx.Client")
+    def test_run_empty_results(self, mock_client):
+        """Test handling of empty results"""
+        mock_response = Mock()
+        mock_response.json.return_value = {"results": []}
+
+        mock_instance = Mock()
+        mock_instance.get.return_value = mock_response
+        mock_client.return_value = mock_instance
+
+        component = SerpexWebSearch(api_key=Secret.from_token("test_key"))
+        result = component.run(query="test query")
+
+        assert "documents" in result
+        assert len(result["documents"]) == 0
+
+    def test_cleanup(self):
+        """Test resource cleanup"""
+        component = SerpexWebSearch(api_key=Secret.from_token("test_key"))
+        assert hasattr(component, "_client")
+
+        # Trigger cleanup
+        component.__del__()
+        # Should not raise any exceptions