+>
+> Are you looking for a managed solution that benefits from Haystack? [deepset Cloud](https://www.deepset.ai/deepset-cloud?utm_campaign=developer-relations&utm_source=haystack&utm_medium=readme) is our fully managed, end-to-end platform to integrate LLMs with your data, which uses Haystack for the LLM pipelines architecture.
+
+## 🔜 Visual Pipeline Editor
+
+Use **deepset Studio** to visually create and export your Haystack pipeline architecture as a YAML or as Python code. Learn more about it in [our announcement post](https://haystack.deepset.ai/blog/announcing-studio).
+
+
+
+
+👉 [Join the waitlist](https://landing.deepset.ai/deepset-studio-waitlist?utm_campaign=2408%20-%20Campaign%20-%20Studio%20Launch&utm_source=github&utm_medium=referral)!
+
+## Telemetry
+
+Haystack collects **anonymous** usage statistics of pipeline components. We receive an event every time these components are initialized. This way, we know which components are most relevant to our community.
+
+Read more about telemetry in Haystack or how you can opt out in [Haystack docs](https://docs.haystack.deepset.ai/docs/telemetry).
+
+## 🖖 Community
+
+If you have a feature request or a bug report, feel free to open an [issue in Github](https://github.com/deepset-ai/haystack/issues). We regularly check these and you can expect a quick response. If you'd like to discuss a topic, or get more general advice on how to make Haystack work for your project, you can start a thread in [Github Discussions](https://github.com/deepset-ai/haystack/discussions) or our [Discord channel](https://discord.com/invite/VBpFzsgRVF). We also check [𝕏 (Twitter)](https://twitter.com/haystack_ai) and [Stack Overflow](https://stackoverflow.com/questions/tagged/haystack).
+
+## Contributing to Haystack
+
+We are very open to the community's contributions - be it a quick fix of a typo, or a completely new feature! You don't need to be a Haystack expert to provide meaningful improvements. To learn how to get started, check out our [Contributor Guidelines](https://github.com/deepset-ai/haystack/blob/main/CONTRIBUTING.md) first.
+
+There are several ways you can contribute to Haystack:
+- Contribute to the main Haystack project
+- Contribute an integration on [haystack-core-integrations](https://github.com/deepset-ai/haystack-core-integrations)
+
+> [!TIP]
+>👉 **[Check out the full list of issues that are open to contributions](https://github.com/orgs/deepset-ai/projects/14)**
+
+## Who Uses Haystack
+
+Here's a list of projects and companies using Haystack. Want to add yours? Open a PR, add it to the list and let the
+world know that you use Haystack!
+
+- [Airbus](https://www.airbus.com/en)
+- [Alcatel-Lucent](https://www.al-enterprise.com/)
+- [Apple](https://www.apple.com/)
+- [BetterUp](https://www.betterup.com/)
+- [Databricks](https://www.databricks.com/)
+- [Deepset](https://deepset.ai/)
+- [Etalab](https://www.deepset.ai/blog/improving-on-site-search-for-government-agencies-etalab)
+- [Infineon](https://www.infineon.com/)
+- [Intel](https://github.com/intel/open-domain-question-and-answer#readme)
+- [Intelijus](https://www.intelijus.ai/)
+- [Intel Labs](https://github.com/IntelLabs/fastRAG#readme)
+- [LEGO](https://github.com/larsbaunwall/bricky#readme)
+- [Netflix](https://netflix.com)
+- [NOS Portugal](https://www.nos.pt/en/welcome)
+- [Nvidia](https://developer.nvidia.com/blog/reducing-development-time-for-intelligent-virtual-assistants-in-contact-centers/)
+- [PostHog](https://github.com/PostHog/max-ai#readme)
+- [Rakuten](https://www.rakuten.com/)
+- [Sooth.ai](https://www.deepset.ai/blog/advanced-neural-search-with-sooth-ai)
diff --git a/testbed/deepset-ai__haystack/SECURITY.md b/testbed/deepset-ai__haystack/SECURITY.md
new file mode 100644
index 0000000000000000000000000000000000000000..1d7370e79deec354cb3702e05803c545af7bb2ab
--- /dev/null
+++ b/testbed/deepset-ai__haystack/SECURITY.md
@@ -0,0 +1,26 @@
+# Security Policy
+
+## Report a Vulnerability
+
+If you found a security vulnerability in Haystack, send a message to
+[security@deepset.ai](mailto:security@deepset.ai).
+
+In your message, please include:
+
+1. Reproducible steps to trigger the vulnerability.
+2. An explanation of what makes you think there is a vulnerability.
+3. Any information you may have on active exploitations of the vulnerability (zero-day).
+
+## Vulnerability Response
+
+We'll review your report within 5 business days and we will do a preliminary analysis
+to confirm that the vulnerability is plausible. Otherwise, we'll decline the report.
+
+We won't disclose any information you share with us but we'll use it to get the issue
+fixed or to coordinate a vendor response, as needed.
+
+We'll keep you updated of the status of the issue.
+
+Our goal is to disclose bugs as soon as possible once a user mitigation is available.
+Once we get a good understanding of the vulnerability, we'll set a disclosure date after
+consulting the author of the report and Haystack maintainers.
diff --git a/testbed/deepset-ai__haystack/VERSION.txt b/testbed/deepset-ai__haystack/VERSION.txt
new file mode 100644
index 0000000000000000000000000000000000000000..32a386165cc8fa3aed468c3bd0b4e9ca377ea78b
--- /dev/null
+++ b/testbed/deepset-ai__haystack/VERSION.txt
@@ -0,0 +1 @@
+2.8.0-rc0
diff --git a/testbed/deepset-ai__haystack/code_of_conduct.txt b/testbed/deepset-ai__haystack/code_of_conduct.txt
new file mode 100644
index 0000000000000000000000000000000000000000..61135cb385878d854077c13b51349d322057ecf3
--- /dev/null
+++ b/testbed/deepset-ai__haystack/code_of_conduct.txt
@@ -0,0 +1,98 @@
+CONTRIBUTOR COVENANT CODE OF CONDUCT
+====================================
+
+Our Pledge
+----------
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for
+everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics,
+gender identity and expression, level of experience, education, socioeconomic status, nationality, personal appearance,
+race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+Our Standards
+-------------
+
+Examples of behavior that contributes to a positive environment for our community include:
+ - Demonstrating empathy and kindness toward other people
+ - Being respectful of differing opinions, viewpoints, and experiences
+ - Giving and gracefully accepting constructive feedback
+ - Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+ - Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+ - The use of sexualized language or imagery, and sexual attention or advances of any kind
+ - Trolling, insulting or derogatory comments, and personal or political attacks
+ - Public or private harassment
+ - Publishing others’ private information, such as a physical or email address, without their explicit permission
+ - Other conduct which could reasonably be considered inappropriate in a professional setting
+
+Enforcement Responsibilities
+----------------------------
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take
+appropriate and fair corrective action in response to any behavior that they deem inappropriate,
+threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
+issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for
+moderation decisions when appropriate.
+
+Scope
+-----
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially
+representing the community in public spaces. Examples of representing our community include using an official
+e-mail address, posting via an official social media account, or acting as an appointed representative
+at an online or offline event.
+
+Enforcement
+-----------
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible
+for enforcement at engage@deepset.ai. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+Enforcement Guidelines
+----------------------
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action
+they deem in violation of this Code of Conduct:
+
+1. Correction
+ Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+ Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation
+ and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+2. Warning
+ Community Impact: A violation through a single incident or series of actions.
+
+ Consequence: A warning with consequences for continued behavior. No interaction with the people involved,
+ including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time.
+ This includes avoiding interactions in community spaces as well as external channels like social media.
+ Violating these terms may lead to a temporary or permanent ban.
+
+3. Temporary Ban
+ Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
+
+ Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified
+ period of time. No public or private interaction with the people involved, including unsolicited interaction with
+ those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+4. Permanent Ban
+ Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+ Consequence: A permanent ban from any sort of public interaction within the community.
+
+Attribution
+-----------
+
+This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by Mozilla’s code of conduct enforcement ladder.
+
+For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq.
+Translations are available at https://www.contributor-covenant.org/translations.
diff --git a/testbed/deepset-ai__haystack/docs/README.md b/testbed/deepset-ai__haystack/docs/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..5e5c1e877ee3d2e1405dd1a4100344858f2aa94f
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/README.md
@@ -0,0 +1,57 @@
+# :ledger: Looking for the docs?
+
+You can find Haystack's documentation at https://docs.haystack.deepset.ai/.
+
+# :computer: How to update docs?
+
+## Overview, Components, Pipeline Nodes, and Guides
+
+You can find these docs on the Haystack Docs page: https://docs.haystack.deepset.ai/docs/get_started. If you want to contribute, and we welcome every contribution, do the following:
+1. Make sure you're on the right version (check the version expanding list in the top left corner).
+2. Use the "Suggest Edits" link you can find in the top right corner of every page.
+3. Suggest a change right in the docs and click **Submit Suggested Edits**.
+4. Optionally, leave us a comment and submit your change.
+
+Once we take care of it, you'll get an email telling you the change's been merged, or not. If not, we'll give you the reason why.
+
+Make sure to check our [Contribution Guidelines](https://github.com/deepset-ai/haystack/blob/main/CONTRIBUTING.md).
+
+## Tutorials
+
+The Tutorials live in a separate repo: https://github.com/deepset-ai/haystack-tutorials. For instructions on how to contribute to tutorials, see [Contributing to Tutorials](https://github.com/deepset-ai/haystack-tutorials/blob/main/Contributing.md#contributing-to-haystack-tutorials).
+
+## API Reference
+
+We use Pydoc-Markdown to create Markdown files from the docstrings in our code. There is a Github Action that regenerates the API pages with each commit.
+
+If you want to generate a new Markdown file for a new Haystack module, create a `.yml` file in `docs/src/api/api` which configures how Pydoc-Markdown will generate the page and commit it to main.
+
+All the updates to doctrings get pushed to documentation when you commit to the main branch.
+
+### Configuration
+
+Pydoc will read the configuration from a `.yml` file which is located under `/haystack/docs/_src/api/pydoc`. Our files contain three main sections:
+
+- **loader**: A list of plugins that load API objects from python source files.
+ - **type**: Loader for python source files
+ - **search_path**: Location of source files
+ - **modules**: Module which are used for generating the markdown file
+ - **ignore_when_discovered**: Define which files should be ignored
+- **processor**: A list of plugins that process API objects to modify their docstrings (e.g. to adapt them from a documentation format to Markdown or to remove items that should not be rendered into the documentation).
+ - **type: filter**: Filter for specific modules
+ - **documented_only**: Only documented API objects
+ - **do_not_filter_modules**: Do not filter module objects
+ - **skip_empty_modules**: Skip modules without content
+- **renderer**: A plugin that produces the output files. We use a custom ReadmeRenderer based on the Markdown renderer. It makes sure the Markdown files comply with ReadMe requirements.
+ - **type**: Define the renderer which you want to use. We are using the ReadmeRenderer to make sure the files display properly in ReadMe.
+ - **excerpt**: Add a short description of the page. It shows up right below the page title.
+ - **category**: This is the ReadMe category ID to make sure the doc lands in the right section of Haystack docs.
+ - **title**: The title of the doc as it will appear on the website. Make sure you always add "API" at the end.
+ - **slug**: The page slug, each word should be separated with a dash.
+ - **order**: Pages are ordered alphabetically. This defines where in the TOC the page lands.
+ - markdown:
+ - **descriptive_class_title**: Remove the word "Object" from class titles.
+ - **descriptive_module_title**: Adding the word “Module” before the module name.
+ - **add_method_class_prefix**: Add the class name as a prefix to method names.
+ - **add_member_class_prefix**: Add the class name as a prefix to member names.
+ - **filename**: File name of the generated file, use underscores to separate each word.
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/audio_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/audio_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..8c6a6708866db2c6e5b49b102a5c4d17a70f744e
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/audio_api.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/audio]
+ modules: ["whisper_local", "whisper_remote"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Transcribes audio files.
+ category_slug: haystack-api
+ title: Audio
+ slug: audio-api
+ order: 3
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: audio_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/builders_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/builders_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..d16085b0c42107eeda21aa03a0385730a34b29d8
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/builders_api.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/builders]
+ modules: ["answer_builder", "prompt_builder", "chat_prompt_builder"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Extract the output of a Generator to an Answer format, and build prompts.
+ category_slug: haystack-api
+ title: Builders
+ slug: builders-api
+ order: 5
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: builders_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/caching_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/caching_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..a38a5ba9381ff40cb6d382b7ae1343da66d2e661
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/caching_api.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/caching]
+ modules: ["cache_checker"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Checks if any document coming from the given URL is already present in the store.
+ category_slug: haystack-api
+ title: Caching
+ slug: caching-api
+ order: 7
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: cachings_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/classifiers_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/classifiers_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..14a97ee7bd38a33297961a29e06cce2c954539d2
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/classifiers_api.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/classifiers]
+ modules: ["document_language_classifier", "zero_shot_document_classifier"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Classify documents based on the provided labels.
+ category_slug: haystack-api
+ title: Classifiers
+ slug: classifiers-api
+ order: 10
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: classifiers_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/connectors.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/connectors.yml
new file mode 100644
index 0000000000000000000000000000000000000000..b53b4bb80f9b138ac4d3468779b54c4f3a3ac421
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/connectors.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/connectors]
+ modules: ["openapi_service"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Various connectors to integrate with external services.
+ category_slug: haystack-api
+ title: Connectors
+ slug: connectors-api
+ order: 15
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: connectors_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/converters_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/converters_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..6c89138c98fd2c93cb72c4bf20ef3117a9f00657
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/converters_api.yml
@@ -0,0 +1,42 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/converters]
+ modules:
+ [
+ "azure",
+ "csv",
+ "docx",
+ "html",
+ "json",
+ "markdown",
+ "openapi_functions",
+ "output_adapter",
+ "pdfminer",
+ "pptx",
+ "pypdf",
+ "tika",
+ "txt",
+ ]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Various converters to transform data from one format to another.
+ category_slug: haystack-api
+ title: Converters
+ slug: converters-api
+ order: 20
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: converters_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/data_classess_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/data_classess_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..a67f28db9d4412faa315d6964a074ab261904f1c
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/data_classess_api.yml
@@ -0,0 +1,28 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/dataclasses]
+ modules:
+ ["answer", "byte_stream", "chat_message", "document", "streaming_chunk", "sparse_embedding"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Core classes that carry data through the system.
+ category_slug: haystack-api
+ title: Data Classes
+ slug: data-classes-api
+ order: 30
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: data_classess_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/document_stores_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/document_stores_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..f9744e197723ef7f9ed42f31543cec17c774cfad
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/document_stores_api.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/document_stores/in_memory]
+ modules: ["document_store"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Stores your texts and meta data and provides them to the Retriever at query time.
+ category_slug: haystack-api
+ title: Document Stores
+ slug: document-stores-api
+ order: 40
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: document_stores_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/document_writers_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/document_writers_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..1d16ae84a4df1c55dd8604faedd3cb9e565d8c9e
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/document_writers_api.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/writers]
+ modules: ["document_writer"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Writes Documents to a DocumentStore.
+ category_slug: haystack-api
+ title: Document Writers
+ slug: document-writers-api
+ order: 50
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: document_writers_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/embedders_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/embedders_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..9528039aa0c236fc2833850d17f6856632732489
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/embedders_api.yml
@@ -0,0 +1,37 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/embedders]
+ modules:
+ [
+ "azure_document_embedder",
+ "azure_text_embedder",
+ "hugging_face_api_document_embedder",
+ "hugging_face_api_text_embedder",
+ "openai_document_embedder",
+ "openai_text_embedder",
+ "sentence_transformers_document_embedder",
+ "sentence_transformers_text_embedder",
+ ]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Transforms queries into vectors to look for similar or relevant Documents.
+ category_slug: haystack-api
+ title: Embedders
+ slug: embedders-api
+ order: 60
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: embedders_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/evaluation_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/evaluation_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..e445e9a56802c593ce22f80a0275a36a15ace76b
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/evaluation_api.yml
@@ -0,0 +1,31 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/evaluation]
+ modules:
+ [
+ "base",
+ "eval_run_result",
+ ]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Represents the results of evaluation.
+ category_slug: haystack-api
+ title: Evaluation
+ slug: evaluation-api
+ order: 61
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: evaluation_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/evaluators_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/evaluators_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..9a8460b94ad6ab272bd0074a7afecb19eb21f269
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/evaluators_api.yml
@@ -0,0 +1,38 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/evaluators]
+ modules:
+ [
+ "answer_exact_match",
+ "context_relevance",
+ "document_map",
+ "document_mrr",
+ "document_ndcg",
+ "document_recall",
+ "faithfulness",
+ "llm_evaluator",
+ "sas_evaluator",
+ ]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Evaluate your pipelines or individual components.
+ category_slug: haystack-api
+ title: Evaluators
+ slug: evaluators-api
+ order: 63
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: evaluators_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/extractors_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/extractors_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..76ee7f0b15a77f3322eadb816fc04c91abfc059b
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/extractors_api.yml
@@ -0,0 +1,29 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/extractors]
+ modules: ["named_entity_extractor"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: filter
+ expression: "name not in ['_BackendEnumMeta', '_NerBackend', '_HfBackend', '_SpacyBackend']"
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Extracts predefined entities out of a piece of text.
+ category_slug: haystack-api
+ title: Extractors
+ slug: extractors-api
+ order: 65
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: extractors_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/fetchers_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/fetchers_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..9e021d3ef4527f3e502dfd90b558061628a7305c
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/fetchers_api.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/fetchers]
+ modules: ["link_content"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Fetches content from a list of URLs and returns a list of extracted content streams.
+ category_slug: haystack-api
+ title: Fetchers
+ slug: fetchers-api
+ order: 80
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: fetchers_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/generators_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/generators_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..4fcfa74879922375ef2a7a6d7d4f3d051546e0fc
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/generators_api.yml
@@ -0,0 +1,37 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/generators]
+ modules:
+ [
+ "azure",
+ "hugging_face_local",
+ "hugging_face_api",
+ "openai",
+ "chat/azure",
+ "chat/hugging_face_local",
+ "chat/hugging_face_api",
+ "chat/openai",
+ ]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Enables text generation using LLMs.
+ category_slug: haystack-api
+ title: Generators
+ slug: generators-api
+ order: 70
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: generators_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/joiners_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/joiners_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..72708f4400d401791c1681c6dcf6c30bef05dc47
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/joiners_api.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/joiners]
+ modules: ["document_joiner", "branch", "answer_joiner", "string_joiner"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Components that join list of different objects
+ category_slug: haystack-api
+ title: Joiners
+ slug: joiners-api
+ order: 75
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: joiners_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/pipeline_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/pipeline_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..d720152510ae3b06f367fbc593991882084cb744
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/pipeline_api.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/core/pipeline]
+ modules: ["pipeline"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Arranges components and integrations in flow.
+ category_slug: haystack-api
+ title: Pipeline
+ slug: pipeline-api
+ order: 90
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: pipeline_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/preprocessors_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/preprocessors_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..c27e01be340f3cfb1eeb618a86c45278ba2e1690
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/preprocessors_api.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/preprocessors]
+ modules: ["document_cleaner", "document_splitter", "text_cleaner", "nltk_document_splitter"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Preprocess your Documents and texts. Clean, split, and more.
+ category_slug: haystack-api
+ title: PreProcessors
+ slug: preprocessors-api
+ order: 100
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: preprocessors_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/rankers_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/rankers_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..31dc468ad863357e39822e3f8f9f74646b04022f
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/rankers_api.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/rankers]
+ modules: ["lost_in_the_middle", "meta_field", "transformers_similarity", "sentence_transformers_diversity"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Reorders a set of Documents based on their relevance to the query.
+ category_slug: haystack-api
+ title: Rankers
+ slug: rankers-api
+ order: 110
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: rankers_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/readers_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/readers_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..ef0974b78ae19473c812d124497c9a9c94678e64
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/readers_api.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/readers]
+ modules: ["extractive"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Takes a query and a set of Documents as input and returns ExtractedAnswers by selecting a text span within the Documents.
+ category_slug: haystack-api
+ title: Readers
+ slug: readers-api
+ order: 120
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: readers_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/retrievers_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/retrievers_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..c7f0e8ebd1ca70a09890629311c4b6adb099ff16
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/retrievers_api.yml
@@ -0,0 +1,33 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/retrievers]
+ modules:
+ [
+ "in_memory/bm25_retriever",
+ "in_memory/embedding_retriever",
+ "filter_retriever",
+ "sentence_window_retriever",
+ ]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Sweeps through a Document Store and returns a set of candidate Documents that are relevant to the query.
+ category_slug: haystack-api
+ title: Retrievers
+ slug: retrievers-api
+ order: 130
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: retrievers_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/routers_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/routers_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..126d08d7ea1fdf5f16b51bb1849b54f1959c43ef
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/routers_api.yml
@@ -0,0 +1,35 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/routers]
+ modules:
+ [
+ "conditional_router",
+ "file_type_router",
+ "metadata_router",
+ "text_language_router",
+ "transformers_text_router",
+ "zero_shot_text_router",
+ ]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Routers is a group of components that route queries or Documents to other components that can handle them best.
+ category_slug: haystack-api
+ title: Routers
+ slug: routers-api
+ order: 140
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: routers_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/samplers_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/samplers_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..f0a5bdbca98ff96fa7f3418456ff5ec87a19b1a2
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/samplers_api.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/samplers]
+ modules: ["top_p"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Filters documents based on their similarity scores using top-p sampling.
+ category_slug: haystack-api
+ title: Samplers
+ slug: samplers-api
+ order: 150
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: samplers_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/utils_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/utils_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..3b32a0276d5a71cf6b05cb238802ae2f4f67ecbd
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/utils_api.yml
@@ -0,0 +1,28 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/utils]
+ ignore_when_discovered: ["__init__", "hf"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: filter
+ expression: "name not in ['TokenSecret', 'EnvVarSecret','_get_default_device', '_split_device_string', 'convert']"
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Utility functions and classes used across the library.
+ category_slug: haystack-api
+ title: Utils
+ slug: utils-api
+ order: 153
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: utils_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/validators_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/validators_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..48b452eeeb5a4d4fec1f4a36ee47fd36f8040d1e
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/validators_api.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/validators]
+ modules: ["json_schema"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Validators validate LLM outputs
+ category_slug: haystack-api
+ title: Validators
+ slug: validators-api
+ order: 155
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: validators_api.md
diff --git a/testbed/deepset-ai__haystack/docs/pydoc/config/websearch_api.yml b/testbed/deepset-ai__haystack/docs/pydoc/config/websearch_api.yml
new file mode 100644
index 0000000000000000000000000000000000000000..daa08fd5f1bcbb28c823db2992668d5d439d755c
--- /dev/null
+++ b/testbed/deepset-ai__haystack/docs/pydoc/config/websearch_api.yml
@@ -0,0 +1,27 @@
+loaders:
+ - type: haystack_pydoc_tools.loaders.CustomPythonLoader
+ search_path: [../../../haystack/components/websearch]
+ modules: ["serper_dev", "searchapi"]
+ ignore_when_discovered: ["__init__"]
+processors:
+ - type: filter
+ expression:
+ documented_only: true
+ do_not_filter_modules: false
+ skip_empty_modules: true
+ - type: smart
+ - type: crossref
+renderer:
+ type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
+ excerpt: Web search engine for Haystack.
+ category_slug: haystack-api
+ title: Websearch
+ slug: websearch-api
+ order: 170
+ markdown:
+ descriptive_class_title: false
+ classdef_code_block: false
+ descriptive_module_title: true
+ add_method_class_prefix: true
+ add_member_class_prefix: false
+ filename: websearch_api.md
diff --git a/testbed/deepset-ai__haystack/examples/README.md b/testbed/deepset-ai__haystack/examples/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..09feb7f18b84b1c6abd9ada958e8631e49c17109
--- /dev/null
+++ b/testbed/deepset-ai__haystack/examples/README.md
@@ -0,0 +1,5 @@
+# Examples have been moved!
+
+If you're searching for Haystack examples we moved them into a dedicated repository.
+
+You can find all the example cookbooks [👉 here 👈](https://github.com/deepset-ai/haystack-cookbook/).
diff --git a/testbed/deepset-ai__haystack/license-header.txt b/testbed/deepset-ai__haystack/license-header.txt
new file mode 100644
index 0000000000000000000000000000000000000000..ec46732299642d1651e93564ccd09cacb8d264eb
--- /dev/null
+++ b/testbed/deepset-ai__haystack/license-header.txt
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: ${inceptionYear}-present ${copyrightOwner}
+
+SPDX-License-Identifier: Apache-2.0
diff --git a/testbed/deepset-ai__haystack/licenserc.toml b/testbed/deepset-ai__haystack/licenserc.toml
new file mode 100644
index 0000000000000000000000000000000000000000..eb0e810056d1b88af2a0c0cf72fc41dc02cadb2e
--- /dev/null
+++ b/testbed/deepset-ai__haystack/licenserc.toml
@@ -0,0 +1,23 @@
+headerPath = "license-header.txt"
+
+excludes = [
+ ".github",
+ "docker",
+ "docs",
+ "examples",
+ "proposals",
+ "releasenotes",
+ "test",
+ "CITATION.cff",
+ "*.ini",
+ "*.jinja2",
+ "*.md",
+ "*.toml",
+ "*.txt",
+ "*.yaml",
+ "*.wav",
+]
+
+[properties]
+inceptionYear = 2022
+copyrightOwner = "deepset GmbH 
What is Haystack?
+Haystack is the open source Python framework by deepset for building custom apps with large language models (LLMs). It lets you quickly try out the latest models in natural language processing (NLP) while being flexible and easy to use. Our inspiring community of users and builders has helped shape Haystack into what it is today: a complete framework for building production-ready NLP apps.
+Building with Haystack
+Haystack offers comprehensive tooling for developing state-of-the-art NLP systems that use LLMs (such as GPT-4, Falcon and similar) and Transformer models . With Haystack, you can effortlessly experiment with various models hosted on platforms like Hugging Face, OpenAI, Cohere, or even models deployed on SageMaker and your local models to find the perfect fit for your use case.
+ + + + + + + + + + + + + + + + + + + + +
+
+
+Some examples of what you can build include:
+-
+
- Semantic search on a large collection of documents in any language +
- Generative question answering on a knowledge base containing mixed types of information: images, text, and tables. +
- Natural language chatbots powered by cutting-edge generative models like GPT-4 +
- An LLM-based Haystack Agent capable of resolving complex queries +
- Information extraction from documents to populate your database or build a knowledge graph +
This is just a small subset of the kinds of systems that can be created in Haystack.
+Functionality for all stages of an NLP project
+A successful NLP project requires more than just the language models. As an end-to-end framework, Haystack assists you in building your system every step of the way, offering tooling for each stage of the NLP project life cycle:
+-
+
- Effortless deployment of models from Hugging Face or other providers into your NLP pipeline +
- Create dynamic templates for LLM prompting +
- +Cleaning and preprocessing functions for various formats and sources +
- +Seamless integrations with your preferred document store (including many popular vector databases like Faiss, Pinecone, Qdrant, or Weaviate): keep your NLP-driven apps up-to-date with Haystack’s indexing pipelines that help you prepare and maintain your data +
- The +free annotation tool for a faster and more structured annotation process +
- Tooling for +fine-tuning a pre-trained language model +
- Specialized +evaluation pipelines that use different metrics to evaluate the entire system or its individual components +
- +Haystack’s REST API to deploy your final system so that you can query it with a user-facing interface +
But that’s not all: +metadata filtering, +model distillation, or the prompt hub, whatever your NLP heart desires, you’re likely to find it in Haystack. And if not? We’ll build it together.
+ + + + + + + + + + + + + + + + + + + + + + +
+
+
+Building blocks
+Haystack uses a few simple but effective concepts to help you build fully functional and customized end-to-end NLP systems.
+Components
+At the core of Haystack are its components—fundamental building blocks that can perform tasks like document retrieval, text generation, or summarization. A single component is already quite powerful. It can manage local language models or communicate with a hosted model through an API.
+While Haystack offers a bunch of components you can use out of the box, it also lets you create your own custom components. Explore the +collection of integrations that includes custom components developed by our community, which you can freely use.
+You can chain components together to build pipelines, which are the foundation of the NLP app architecture in Haystack.
+Pipelines
+Pipelines are powerful structures made up of components, such as a Retriever and Reader, connected to infrastructure building blocks, such as a DocumentStore (for example, Elasticsearch or Weaviate) to form complex systems.
+Haystack offers ready-made pipelines for most common tasks, such as question answering, document retrieval, or summarization. But it’s just as easy to design and create a custom pipeline for NLP scenarios that are way more complex than question answering.
+Agents
+The Haystack Agent makes use of a large language model to resolve complex tasks. When initializing the Agent, you give it a set of tools, which can be pipeline components or whole pipelines. The Agent can use to those tools iteratively to arrive at an answer. When given a query, the Agent determines which tools are useful to answer this query and calls them in a loop until it gets the answer. This way, it can achieve much more than extractive or generative question answering pipelines.
+ + + + + + + + + + + + + + + + + + + + +
+
+
+Who’s it for?
+Haystack is for everyone looking to build natural language apps—NLP enthusiasts and newbies alike. You don’t need to understand how the models work under the hood. With Haystack’s modular and flexible components, pipelines, and agents, all you need is some basic knowledge of Python to dive right in.
+Our community
+At the heart of Haystack is the vibrant open source community that thrives on the diverse backgrounds and skill sets of its members. We value collaboration greatly and encourage our users to shape Haystack actively through GitHub contributions. Our Discord channel is a space where community members can connect, seek help, and learn from each other.
+We also organize live online and in-person events, webinars, and office hours, which are an opportunity to learn and grow.
+ + + + + + + + + + + +Enter the Haystack universe
+-
+
- Visit our +GitHub repo +
- Start building with +tutorials in Colab notebooks +
- Have a look at the +documentation +
- Read and contribute to our +blog +