youcom-haystack 0.0.1__tar.gz

youcom_haystack-0.0.1/.gitignore

@@ -0,0 +1,146 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# 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
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+volumes/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# IDEs
+.vscode
+
+# Docs generation artifacts
+_readme_*.md
+.idea
+
+# macOS
+.DS_Store
+
+# http cache (requests-cache)
+**/http_cache.sqlite
+
+# ruff
+.ruff_cache

youcom_haystack-0.0.1/LICENSE.txt

@@ -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 2023-present deepset GmbH
+
+   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.

youcom_haystack-0.0.1/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.5
+Name: youcom-haystack
+Version: 0.0.1
+Summary: Haystack integration for the You.com Search API
+Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/youcom#readme
+Project-URL: Issues, https://github.com/deepset-ai/haystack-core-integrations/issues
+Project-URL: Source, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/youcom
+Author-email: deepset GmbH <info@deepset.ai>, "You.com" <developers@you.com>
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
+Keywords: AI Search,Haystack,Web Search,You.com
+Classifier: Development Status :: 4 - Beta
+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: httpx>=0.27.0
+Description-Content-Type: text/markdown
+
+# youcom-haystack
+
+[![PyPI - Version](https://img.shields.io/pypi/v/youcom-haystack.svg)](https://pypi.org/project/youcom-haystack)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/youcom-haystack.svg)](https://pypi.org/project/youcom-haystack)
+
+- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/youcom/CHANGELOG.md)
+
+---
+
+## Usage
+
+`YouComWebSearch` runs without any configuration: with no API key available it uses the You.com
+[keyless free tier](https://you.com/docs/api-reference/search/v1-agents-search) (rate limited per IP).
+Set the `YOUDOTCOM_API_KEY` environment variable to use the keyed
+[You.com Search API](https://you.com/docs/api-reference/search/v1-search) with higher limits.
+
+```python
+from haystack_integrations.components.websearch.youcom import YouComWebSearch
+
+websearch = YouComWebSearch(top_k=5)
+result = websearch.run(query="What is Haystack by deepset?")
+result["documents"]  # list[Document]
+result["links"]  # list[str]
+```
+
+To require a key instead of silently degrading to the keyless tier, pass `keyless_fallback=False`;
+the component then raises `YouComError` when no key resolves.
+
+## Contributing
+
+Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).
+
+The unit tests are fully mocked and need no credentials. The integration tests include one live keyless
+search that needs no key; to also run the keyed tests, export the `YOUDOTCOM_API_KEY` environment variable.

youcom_haystack-0.0.1/README.md

@@ -0,0 +1,34 @@
+# youcom-haystack
+
+[![PyPI - Version](https://img.shields.io/pypi/v/youcom-haystack.svg)](https://pypi.org/project/youcom-haystack)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/youcom-haystack.svg)](https://pypi.org/project/youcom-haystack)
+
+- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/youcom/CHANGELOG.md)
+
+---
+
+## Usage
+
+`YouComWebSearch` runs without any configuration: with no API key available it uses the You.com
+[keyless free tier](https://you.com/docs/api-reference/search/v1-agents-search) (rate limited per IP).
+Set the `YOUDOTCOM_API_KEY` environment variable to use the keyed
+[You.com Search API](https://you.com/docs/api-reference/search/v1-search) with higher limits.
+
+```python
+from haystack_integrations.components.websearch.youcom import YouComWebSearch
+
+websearch = YouComWebSearch(top_k=5)
+result = websearch.run(query="What is Haystack by deepset?")
+result["documents"]  # list[Document]
+result["links"]  # list[str]
+```
+
+To require a key instead of silently degrading to the keyless tier, pass `keyless_fallback=False`;
+the component then raises `YouComError` when no key resolves.
+
+## Contributing
+
+Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).
+
+The unit tests are fully mocked and need no credentials. The integration tests include one live keyless
+search that needs no key; to also run the keyed tests, export the `YOUDOTCOM_API_KEY` environment variable.

youcom_haystack-0.0.1/pydoc/config_docusaurus.yml

@@ -0,0 +1,13 @@
+loaders:
+  - modules:
+      - haystack_integrations.components.websearch.youcom.youcom_websearch
+    search_path: [../src]
+processors:
+  - type: filter
+    documented_only: true
+    skip_empty_modules: true
+renderer:
+  description: You.com Search integration for Haystack
+  id: integrations-youcom
+  filename: youcom.md
+  title: You.com Search

youcom_haystack-0.0.1/pyproject.toml

@@ -0,0 +1,170 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "youcom-haystack"
+dynamic = ["version"]
+description = "Haystack integration for the You.com Search API"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+keywords = ["Haystack", "You.com", "Web Search", "AI Search"]
+authors = [
+  { name = "deepset GmbH", email = "info@deepset.ai" },
+  { name = "You.com", email = "developers@you.com" },
+]
+classifiers = [
+  "License :: OSI Approved :: Apache Software License",
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = ["haystack-ai>=2.24.1", "httpx>=0.27.0"]
+
+[project.urls]
+Documentation = "https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/youcom#readme"
+Issues = "https://github.com/deepset-ai/haystack-core-integrations/issues"
+Source = "https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/youcom"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/haystack_integrations"]
+
+[tool.hatch.version]
+source = "vcs"
+tag-pattern = 'integrations\/youcom-v(?P<version>.*)'
+
+[tool.hatch.version.raw-options]
+root = "../.."
+git_describe_command = 'git describe --tags --match="integrations/youcom-v[0-9]*"'
+
+[tool.hatch.envs.default]
+installer = "uv"
+dependencies = ["haystack-pydoc-tools", "ruff"]
+
+[tool.hatch.envs.default.scripts]
+docs = ["haystack-pydoc pydoc/config_docusaurus.yml"]
+fmt = "ruff check --fix {args}; ruff format {args}"
+fmt-check = "ruff check {args} && ruff format --check {args}"
+
+[tool.hatch.envs.test]
+dependencies = [
+    "pytest",
+    "pytest-asyncio",
+    "pytest-cov",
+    "pytest-rerunfailures",
+    "mypy",
+    "pip",
+]
+
+[tool.hatch.envs.test.scripts]
+unit = 'pytest -m "not integration" {args:tests}'
+integration = 'pytest -m "integration" {args:tests}'
+all = 'pytest {args:tests}'
+unit-cov-retry = 'pytest --cov=haystack_integrations --reruns 3 --reruns-delay 30 -x -m "not integration" {args:tests}'
+integration-cov-append-retry = 'pytest --cov=haystack_integrations --cov-append --reruns 3 --reruns-delay 30 -x -m "integration" {args:tests}'
+types = "mypy -p haystack_integrations.components.websearch.youcom {args}"
+
+[tool.mypy]
+install_types = true
+non_interactive = true
+check_untyped_defs = true
+disallow_incomplete_defs = true
+
+[[tool.mypy.overrides]]
+module = ["httpx.*"]
+ignore_missing_imports = true
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "A",
+    "ANN",
+    "ARG",
+    "B",
+    "C",
+    "D102",   # Missing docstring in public method
+    "D103",   # Missing docstring in public function
+    "D205",   # 1 blank line required between summary line and description
+    "D209",   # Closing triple quotes go to new line
+    "D213",   # summary lines must be positioned on the second physical line of the docstring
+    "D417",   # Missing argument descriptions in the docstring
+    "D419",   # Docstring is empty
+    "DTZ",
+    "E",
+    "EM",
+    "F",
+    "I",
+    "ICN",
+    "ISC",
+    "N",
+    "PLC",
+    "PLE",
+    "PLR",
+    "PLW",
+    "Q",
+    "RUF",
+    "S",
+    "T",
+    "TID",
+    "UP",
+    "W",
+    "YTT",
+]
+ignore = [
+    # Allow non-abstract empty methods in abstract base classes
+    "B027",
+    # Allow function calls in argument defaults (common Haystack pattern for Secret.from_env_var)
+    "B008",
+    # Ignore checks for possible passwords
+    "S105",
+    "S106",
+    "S107",
+    # Ignore complexity
+    "C901",
+    "PLR0911",
+    "PLR0912",
+    "PLR0913",
+    "PLR0915",
+    "PLR0917",
+    # Allow `Any` type - used legitimately for dynamic types and SDK boundaries
+    "ANN401",
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["haystack_integrations"]
+
+[tool.ruff.lint.flake8-tidy-imports]
+ban-relative-imports = "parents"
+
+[tool.ruff.lint.per-file-ignores]
+# Tests can use magic values, assertions, relative imports, and don't need type annotations
+"tests/**/*" = ["PLR2004", "S101", "TID252", "D", "ANN"]
+
+[tool.coverage.run]
+source = ["haystack_integrations"]
+branch = true
+parallel = false
+relative_files = true
+
+[tool.coverage.report]
+omit = ["*/tests/*", "*/__init__.py"]
+show_missing = true
+exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"]
+
+[tool.pytest.ini_options]
+addopts = "--strict-markers"
+markers = [
+  "integration: integration tests",
+]
+log_cli = true
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"

youcom_haystack-0.0.1/src/haystack_integrations/components/websearch/youcom/__init__.py

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from haystack_integrations.components.websearch.youcom.youcom_websearch import YouComError, YouComWebSearch
+
+__all__ = ["YouComError", "YouComWebSearch"]

youcom_haystack-0.0.1/src/haystack_integrations/components/websearch/youcom/youcom_websearch.py

@@ -0,0 +1,283 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from importlib.metadata import PackageNotFoundError, version
+from typing import Any
+
+import httpx
+from haystack import ComponentError, Document, component, logging
+from haystack.utils import Secret
+from haystack.utils.requests_utils import async_request_with_retry, request_with_retry
+
+logger = logging.getLogger(__name__)
+
+YOUCOM_KEYED_SEARCH_URL = "https://api.you.com/v1/search"
+YOUCOM_KEYLESS_SEARCH_URL = "https://api.you.com/v1/agents/search"
+
+API_KEY_ENV_VAR = "YOUDOTCOM_API_KEY"
+
+try:
+    _VERSION = version("youcom-haystack")
+except PackageNotFoundError:  # pragma: no cover
+    _VERSION = "0.0.0-dev"
+
+USER_AGENT = f"youcom-haystack/{_VERSION} youdotcom-integration/deepset-ai-haystack-core-integrations"
+
+_RATE_LIMIT_STATUSES = (402, 429)
+_UPGRADE_HINT = (
+    "You.com keyless free-tier limit reached. Set the YOUDOTCOM_API_KEY environment variable "
+    "(or pass api_key) for higher limits — get a free API key at https://you.com/platform."
+)
+
+
+class YouComError(ComponentError):
+    """An error occurred while querying the You.com Search API."""
+
+
+@component
+class YouComWebSearch:
+    """
+    A component that uses the You.com Search API to search the web and return results as Haystack Documents.
+
+    Works with zero configuration: when no API key is available, searches use You.com's
+    [keyless free tier](https://you.com/docs/api-reference/search/v1-agents-search) (rate limited
+    per IP), so getting-started pipelines run without any setup. Set the `YOUDOTCOM_API_KEY`
+    environment variable (or pass `api_key`) to use the keyed
+    [You.com Search API](https://you.com/docs/api-reference/search/v1-search) with higher limits.
+
+    Pass `keyless_fallback=False` to require a key and fail fast instead of degrading to the
+    keyless tier — useful in production pipelines where a missing key should surface as an error.
+
+    ### Usage example
+
+    ```python
+    from haystack_integrations.components.websearch.youcom import YouComWebSearch
+
+    websearch = YouComWebSearch(top_k=5)  # no API key needed to get started
+    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(API_KEY_ENV_VAR, strict=False),
+        keyless_fallback: bool = True,
+        top_k: int | None = 10,
+        freshness: str | None = None,
+        country: str | None = None,
+        search_lang: str | None = None,
+        safesearch: str | None = None,
+        extra_params: dict[str, Any] | None = None,
+        timeout: int = 10,
+        max_retries: int = 3,
+    ) -> None:
+        """
+        Initialize the YouComWebSearch component.
+
+        :param api_key:
+            You.com API key. Defaults to the `YOUDOTCOM_API_KEY` environment variable. Resolved
+            leniently, so an unset key is not an error — see `keyless_fallback` for what happens then.
+        :param keyless_fallback:
+            What to do when no API key resolves. When `True` (the default), search the
+            [keyless free tier](https://you.com/docs/api-reference/search/v1-agents-search),
+            which needs no credentials but is rate limited per IP; the component logs which
+            endpoint it selected. When `False`, raise `YouComError` instead, so a missing key
+            fails fast rather than silently degrading.
+        :param top_k:
+            Maximum number of results to return per section (web, news). Maps to the
+            `count` parameter in the You.com API (1-100).
+        :param freshness:
+            Only return results from within the given window: `"day"`, `"week"`, `"month"`,
+            `"year"`, or a date range in the format `"YYYY-MM-DDtoYYYY-MM-DD"`.
+        :param country:
+            2-letter country code determining the geographical focus of web results (e.g. `"US"`, `"DE"`).
+        :param search_lang:
+            Language of the returned web results in BCP 47 format (e.g. `"EN"`, `"PT-BR"`).
+            Maps to the `language` parameter in the You.com API.
+        :param safesearch:
+            Content moderation level: `"off"`, `"moderate"`, or `"strict"`.
+        :param extra_params:
+            Additional query parameters passed directly to the You.com Search API
+            (e.g. `{"include_domains": "nytimes.com,bbc.com"}`).
+        :param timeout:
+            Timeout in seconds for the HTTP request. Defaults to 10.
+        :param max_retries:
+            Maximum number of retry attempts on transient failures. Defaults to 3.
+        """
+        self.api_key = api_key
+        self.keyless_fallback = keyless_fallback
+        self.top_k = top_k
+        self.freshness = freshness
+        self.country = country
+        self.search_lang = search_lang
+        self.safesearch = safesearch
+        self.extra_params = extra_params
+        self.timeout = timeout
+        self.max_retries = max_retries
+
+    @component.output_types(documents=list[Document], links=list[str])
+    def run(
+        self,
+        query: str,
+        top_k: int | None = None,
+    ) -> dict[str, Any]:
+        """
+        Search the web using the You.com Search API and return results as Documents.
+
+        :param query: Search query string.
+        :param top_k:
+            Optional per-run override of the maximum number of results.
+            If not provided, the init-time `top_k` is used.
+        :returns: A dictionary with:
+            - `documents`: List of Documents containing search result content.
+            - `links`: List of URLs from the search results.
+        :raises YouComError: If the You.com Search API request fails.
+        """
+        url, headers = self._build_request()
+        params = self._build_params(query=query, top_k=top_k)
+
+        try:
+            response = request_with_retry(
+                attempts=self.max_retries,
+                method="GET",
+                url=url,
+                params=params,
+                headers=headers,
+                timeout=self.timeout,
+            )
+        except httpx.HTTPError as error:
+            raise YouComError(self._error_message(error, headers)) from error
+        return self._parse_response(response.json())
+
+    @component.output_types(documents=list[Document], links=list[str])
+    async def run_async(
+        self,
+        query: str,
+        top_k: int | None = None,
+    ) -> dict[str, Any]:
+        """
+        Asynchronously search the web using the You.com Search API and return results as Documents.
+
+        :param query: Search query string.
+        :param top_k:
+            Optional per-run override of the maximum number of results.
+            If not provided, the init-time `top_k` is used.
+        :returns: A dictionary with:
+            - `documents`: List of Documents containing search result content.
+            - `links`: List of URLs from the search results.
+        :raises YouComError: If the You.com Search API request fails.
+        """
+        url, headers = self._build_request()
+        params = self._build_params(query=query, top_k=top_k)
+
+        try:
+            response = await async_request_with_retry(
+                attempts=self.max_retries,
+                method="GET",
+                url=url,
+                params=params,
+                headers=headers,
+                timeout=self.timeout,
+            )
+        except httpx.HTTPError as error:
+            raise YouComError(self._error_message(error, headers)) from error
+        return self._parse_response(response.json())
+
+    def _build_request(self) -> tuple[str, dict[str, str]]:
+        """
+        Select the endpoint and headers based on API key availability.
+
+        With a resolvable API key, requests go to the keyed You.com Search API. Without one,
+        requests fall back to the keyless free tier, unless `keyless_fallback` is disabled.
+
+        :raises YouComError: If no API key resolves and `keyless_fallback` is `False`.
+        """
+        headers = {
+            "Accept": "application/json",
+            "User-Agent": USER_AGENT,
+        }
+        api_key = self.api_key.resolve_value() if self.api_key else None
+        if api_key:
+            headers["X-API-Key"] = api_key
+            return YOUCOM_KEYED_SEARCH_URL, headers
+
+        if not self.keyless_fallback:
+            msg = (
+                "No You.com API key resolved and keyless_fallback is disabled. Set the "
+                f"{API_KEY_ENV_VAR} environment variable, pass api_key explicitly, "
+                "or enable keyless_fallback to use the rate-limited keyless tier."
+            )
+            raise YouComError(msg)
+
+        logger.debug(
+            "No You.com API key resolved; using the keyless free tier at {url}, which is rate "
+            "limited per IP. Set keyless_fallback=False to require a key instead.",
+            url=YOUCOM_KEYLESS_SEARCH_URL,
+        )
+        return YOUCOM_KEYLESS_SEARCH_URL, headers
+
+    def _build_params(self, query: str, top_k: int | None) -> dict[str, Any]:
+        effective_top_k = top_k if top_k is not None else self.top_k
+        params: dict[str, Any] = {"query": query}
+        if effective_top_k is not None:
+            params["count"] = effective_top_k
+        if self.freshness is not None:
+            params["freshness"] = self.freshness
+        if self.country is not None:
+            params["country"] = self.country
+        if self.search_lang is not None:
+            params["language"] = self.search_lang
+        if self.safesearch is not None:
+            params["safesearch"] = self.safesearch
+        if self.extra_params:
+            params.update(self.extra_params)
+        return params
+
+    @staticmethod
+    def _error_message(error: httpx.HTTPError, headers: dict[str, str]) -> str:
+        """
+        Build the `YouComError` message, adding upgrade guidance for keyless rate-limit responses.
+        """
+        message = f"An error occurred while querying the You.com Search API. Error: {error}"
+        if not isinstance(error, httpx.HTTPStatusError):
+            return message
+
+        message = f"{message}, Response: {error.response.text}"
+        if error.response.status_code in _RATE_LIMIT_STATUSES and "X-API-Key" not in headers:
+            message = f"{message} — {_UPGRADE_HINT}"
+        return message
+
+    @staticmethod
+    def _parse_response(response: dict[str, Any]) -> dict[str, Any]:
+        """
+        Convert a You.com Search API response to Haystack Documents and links.
+
+        Web results come first, then news results. Document content is the joined
+        text snippets when available, falling back to the result description.
+
+        :param response: You.com Search API response dictionary.
+        :returns: Dictionary with `documents` and `links` keys.
+        """
+        documents: list[Document] = []
+        links: list[str] = []
+
+        results = response.get("results", {})
+        for section in ("web", "news"):
+            for result in results.get(section) or []:
+                url = result.get("url", "")
+                title = result.get("title", "")
+                snippets = result.get("snippets") or []
+                content = "\n".join(snippets) if snippets else result.get("description", "")
+
+                meta: dict[str, Any] = {"title": title, "url": url, "source": section}
+                if result.get("page_age"):
+                    meta["page_age"] = result["page_age"]
+
+                documents.append(Document(content=content, meta=meta))
+                if url:
+                    links.append(url)
+
+        return {"documents": documents, "links": links}

youcom_haystack-0.0.1/tests/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0

youcom_haystack-0.0.1/tests/test_youcom_websearch.py

@@ -0,0 +1,350 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import os
+from unittest.mock import AsyncMock, MagicMock, patch
+
+import httpx
+import pytest
+from haystack import Document
+from haystack.core.serialization import component_from_dict, component_to_dict
+from haystack.utils import Secret
+
+from haystack_integrations.components.websearch.youcom import YouComError, YouComWebSearch
+from haystack_integrations.components.websearch.youcom.youcom_websearch import (
+    API_KEY_ENV_VAR,
+    USER_AGENT,
+    YOUCOM_KEYED_SEARCH_URL,
+    YOUCOM_KEYLESS_SEARCH_URL,
+)
+
+SAMPLE_RESPONSE = {
+    "results": {
+        "web": [
+            {
+                "url": "https://haystack.deepset.ai",
+                "title": "Haystack | Haystack",
+                "description": "Open-source AI framework",
+                "snippets": ["Haystack is an open-source framework", "for building production-ready AI pipelines"],
+                "page_age": "2026-07-01T00:00:00",
+            },
+        ],
+        "news": [
+            {
+                "url": "https://example.com/news",
+                "title": "AI news item",
+                "description": "A news description",
+                "page_age": "2026-07-20T00:00:00",
+            },
+        ],
+    },
+    "metadata": {"query": "test", "latency": 0.1},
+}
+
+
+def mock_response(json_body, status_code=200):
+    response = MagicMock()
+    response.status_code = status_code
+    response.json.return_value = json_body
+    return response
+
+
+def _keyed_env():
+    """True when the API key env var holds a value, so the keyed live tests can run."""
+    return bool(os.environ.get(API_KEY_ENV_VAR))
+
+
+def http_status_error(status_code, message="Client Error"):
+    """Build the `httpx.HTTPStatusError` that `request_with_retry` raises for an error response."""
+    request = httpx.Request("GET", YOUCOM_KEYLESS_SEARCH_URL)
+    response = httpx.Response(status_code, request=request)
+    return httpx.HTTPStatusError(f"{status_code} {message}", request=request, response=response)
+
+
+class TestYouComWebSearch:
+    @pytest.fixture(autouse=True)
+    def clean_env(self, monkeypatch):
+        monkeypatch.delenv(API_KEY_ENV_VAR, raising=False)
+
+    def test_init_defaults(self):
+        component = YouComWebSearch()
+        assert component.api_key == Secret.from_env_var(API_KEY_ENV_VAR, strict=False)
+        assert component.keyless_fallback is True
+        assert component.top_k == 10
+        assert component.freshness is None
+        assert component.country is None
+        assert component.search_lang is None
+        assert component.safesearch is None
+        assert component.extra_params is None
+        assert component.timeout == 10
+        assert component.max_retries == 3
+
+    def test_init_without_env_var_does_not_raise(self):
+        component = YouComWebSearch()
+        assert component.api_key.resolve_value() is None
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.request_with_retry")
+    def test_run_keyless_when_no_api_key(self, mock_request):
+        mock_request.return_value = mock_response(SAMPLE_RESPONSE)
+
+        component = YouComWebSearch()
+        component.run(query="test")
+
+        kwargs = mock_request.call_args.kwargs
+        assert kwargs["url"] == YOUCOM_KEYLESS_SEARCH_URL
+        assert "X-API-Key" not in kwargs["headers"]
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.request_with_retry")
+    def test_run_keyed_when_env_var_set(self, mock_request, monkeypatch):
+        monkeypatch.setenv("YOUDOTCOM_API_KEY", "env-key")
+        mock_request.return_value = mock_response(SAMPLE_RESPONSE)
+
+        component = YouComWebSearch()
+        component.run(query="test")
+
+        kwargs = mock_request.call_args.kwargs
+        assert kwargs["url"] == YOUCOM_KEYED_SEARCH_URL
+        assert kwargs["headers"]["X-API-Key"] == "env-key"
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.request_with_retry")
+    def test_keyless_fallback_disabled_raises_without_key(self, mock_request):
+        component = YouComWebSearch(keyless_fallback=False)
+
+        with pytest.raises(YouComError, match="keyless_fallback"):
+            component.run(query="test")
+        mock_request.assert_not_called()
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.request_with_retry")
+    def test_keyless_fallback_disabled_still_searches_with_key(self, mock_request, monkeypatch):
+        monkeypatch.setenv("YOUDOTCOM_API_KEY", "env-key")
+        mock_request.return_value = mock_response(SAMPLE_RESPONSE)
+
+        component = YouComWebSearch(keyless_fallback=False)
+        component.run(query="test")
+
+        assert mock_request.call_args.kwargs["url"] == YOUCOM_KEYED_SEARCH_URL
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.async_request_with_retry")
+    async def test_keyless_fallback_disabled_raises_without_key_async(self, mock_request):
+        component = YouComWebSearch(keyless_fallback=False)
+
+        with pytest.raises(YouComError, match="keyless_fallback"):
+            await component.run_async(query="test")
+        mock_request.assert_not_called()
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.request_with_retry")
+    def test_run_keyed_with_explicit_token(self, mock_request):
+        mock_request.return_value = mock_response(SAMPLE_RESPONSE)
+
+        component = YouComWebSearch(api_key=Secret.from_token("explicit-key"))
+        component.run(query="test")
+
+        kwargs = mock_request.call_args.kwargs
+        assert kwargs["url"] == YOUCOM_KEYED_SEARCH_URL
+        assert kwargs["headers"]["X-API-Key"] == "explicit-key"
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.request_with_retry")
+    def test_run_sends_user_agent(self, mock_request):
+        mock_request.return_value = mock_response(SAMPLE_RESPONSE)
+
+        component = YouComWebSearch()
+        component.run(query="test")
+
+        headers = mock_request.call_args.kwargs["headers"]
+        assert headers["User-Agent"] == USER_AGENT
+        assert USER_AGENT.startswith("youcom-haystack/")
+        assert USER_AGENT.endswith(" youdotcom-integration/deepset-ai-haystack-core-integrations")
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.request_with_retry")
+    def test_run_builds_params(self, mock_request):
+        mock_request.return_value = mock_response(SAMPLE_RESPONSE)
+
+        component = YouComWebSearch(
+            top_k=5,
+            freshness="week",
+            country="US",
+            search_lang="EN",
+            safesearch="moderate",
+            extra_params={"include_domains": "nytimes.com,bbc.com"},
+        )
+        component.run(query="climate news")
+
+        params = mock_request.call_args.kwargs["params"]
+        assert params == {
+            "query": "climate news",
+            "count": 5,
+            "freshness": "week",
+            "country": "US",
+            "language": "EN",
+            "safesearch": "moderate",
+            "include_domains": "nytimes.com,bbc.com",
+        }
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.request_with_retry")
+    def test_run_top_k_override(self, mock_request):
+        mock_request.return_value = mock_response(SAMPLE_RESPONSE)
+
+        component = YouComWebSearch(top_k=10)
+        component.run(query="q", top_k=3)
+
+        assert mock_request.call_args.kwargs["params"]["count"] == 3
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.request_with_retry")
+    def test_run_parses_documents_and_links(self, mock_request):
+        mock_request.return_value = mock_response(SAMPLE_RESPONSE)
+
+        component = YouComWebSearch()
+        result = component.run(query="test")
+
+        documents = result["documents"]
+        links = result["links"]
+        assert len(documents) == 2
+        assert all(isinstance(doc, Document) for doc in documents)
+
+        web_doc = documents[0]
+        assert web_doc.content == "Haystack is an open-source framework\nfor building production-ready AI pipelines"
+        assert web_doc.meta == {
+            "title": "Haystack | Haystack",
+            "url": "https://haystack.deepset.ai",
+            "source": "web",
+            "page_age": "2026-07-01T00:00:00",
+        }
+
+        news_doc = documents[1]
+        assert news_doc.content == "A news description"
+        assert news_doc.meta["source"] == "news"
+
+        assert links == ["https://haystack.deepset.ai", "https://example.com/news"]
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.request_with_retry")
+    def test_run_empty_results(self, mock_request):
+        mock_request.return_value = mock_response({"results": {"web": [], "news": []}})
+
+        component = YouComWebSearch()
+        result = component.run(query="test")
+
+        assert result == {"documents": [], "links": []}
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.request_with_retry")
+    def test_run_missing_sections(self, mock_request):
+        mock_request.return_value = mock_response({"metadata": {}})
+
+        component = YouComWebSearch()
+        result = component.run(query="test")
+
+        assert result == {"documents": [], "links": []}
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.request_with_retry")
+    def test_run_null_sections(self, mock_request):
+        mock_request.return_value = mock_response({"results": {"web": None, "news": None}})
+
+        component = YouComWebSearch()
+        result = component.run(query="test")
+
+        assert result == {"documents": [], "links": []}
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.request_with_retry")
+    def test_keyless_rate_limit_error_includes_upgrade_hint(self, mock_request):
+        mock_request.side_effect = http_status_error(402)
+
+        component = YouComWebSearch()
+        with pytest.raises(YouComError, match="YOUDOTCOM_API_KEY"):
+            component.run(query="test")
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.request_with_retry")
+    def test_keyed_error_is_not_rewritten(self, mock_request):
+        mock_request.side_effect = http_status_error(401, "Unauthorized")
+
+        component = YouComWebSearch(api_key=Secret.from_token("bad-key"))
+        with pytest.raises(YouComError, match="401") as excinfo:
+            component.run(query="test")
+        assert "YOUDOTCOM_API_KEY" not in str(excinfo.value)
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.request_with_retry")
+    def test_network_error_is_wrapped(self, mock_request):
+        """Transport-level failures have no response, so they are reported without one."""
+        mock_request.side_effect = httpx.ConnectError("connection refused")
+
+        component = YouComWebSearch()
+        with pytest.raises(YouComError, match="connection refused") as excinfo:
+            component.run(query="test")
+        assert "Response:" not in str(excinfo.value)
+        assert isinstance(excinfo.value.__cause__, httpx.ConnectError)
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.async_request_with_retry")
+    async def test_run_async(self, mock_request):
+        mock_request.side_effect = AsyncMock(return_value=mock_response(SAMPLE_RESPONSE))
+
+        component = YouComWebSearch()
+        result = await component.run_async(query="test")
+
+        assert len(result["documents"]) == 2
+        assert mock_request.call_args.kwargs["url"] == YOUCOM_KEYLESS_SEARCH_URL
+
+    @patch("haystack_integrations.components.websearch.youcom.youcom_websearch.async_request_with_retry")
+    async def test_run_async_keyless_rate_limit_error_includes_upgrade_hint(self, mock_request):
+        mock_request.side_effect = AsyncMock(side_effect=http_status_error(429, "Too Many Requests"))
+
+        component = YouComWebSearch()
+        with pytest.raises(YouComError, match="YOUDOTCOM_API_KEY"):
+            await component.run_async(query="test")
+
+    def test_serialization_roundtrip_without_env_var(self):
+        component = YouComWebSearch(top_k=7, freshness="month", keyless_fallback=False)
+        data = component_to_dict(component, name="websearch")
+        restored = component_from_dict(YouComWebSearch, data, name="websearch")
+
+        assert data["init_parameters"]["keyless_fallback"] is False
+        assert restored.top_k == 7
+        assert restored.freshness == "month"
+        assert restored.keyless_fallback is False
+        assert restored.api_key == Secret.from_env_var(API_KEY_ENV_VAR, strict=False)
+
+    def test_serialization_roundtrip_with_env_var(self, monkeypatch):
+        monkeypatch.setenv("YOUDOTCOM_API_KEY", "env-key")
+        component = YouComWebSearch()
+        data = component_to_dict(component, name="websearch")
+        restored = component_from_dict(YouComWebSearch, data, name="websearch")
+
+        assert restored.api_key.resolve_value() == "env-key"
+
+    def test_serialization_does_not_leak_token_secret(self):
+        component = YouComWebSearch(api_key=Secret.from_token("super-secret"))
+        with pytest.raises(ValueError, match="Cannot serialize token-based secret"):
+            component_to_dict(component, name="websearch")
+
+
+@pytest.mark.integration
+class TestYouComWebSearchIntegration:
+    def test_keyless_live_search(self, monkeypatch):
+        """The keyless free tier is rate limited per IP, so a shared CI runner may legitimately hit the limit."""
+        monkeypatch.delenv(API_KEY_ENV_VAR, raising=False)
+        component = YouComWebSearch(top_k=2)
+        try:
+            result = component.run(query="What is Haystack by deepset?")
+        except YouComError as error:
+            cause = error.__cause__
+            status = cause.response.status_code if isinstance(cause, httpx.HTTPStatusError) else None
+            if status in (402, 429):
+                pytest.skip(f"keyless free-tier rate limit hit: {status}")
+            raise
+
+        assert len(result["documents"]) > 0
+        assert len(result["links"]) > 0
+        assert result["documents"][0].content
+
+    @pytest.mark.skipif(not _keyed_env(), reason="no You.com API key in the environment")
+    def test_keyed_live_search(self):
+        component = YouComWebSearch(top_k=2)
+        result = component.run(query="What is Haystack by deepset?")
+
+        assert len(result["documents"]) > 0
+        assert len(result["links"]) > 0
+
+    @pytest.mark.skipif(not _keyed_env(), reason="no You.com API key in the environment")
+    async def test_keyed_live_search_async(self):
+        component = YouComWebSearch(top_k=2)
+        result = await component.run_async(query="What is Haystack by deepset?")
+
+        assert len(result["documents"]) > 0