docs: 2.0 API reference (#6262)

* docs: 2.0 API reference

* add builders and generators

* classifiers file path

docs/pydoc/config-preview/builder.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/components/builders]
+    modules: ["answer_builder", "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: renderers.ReadmePreviewRenderer
+  excerpt: Extract the output of a Generator to an Answer format, and build prompts.
+  category_slug: haystack-classes
+  title: Builder API
+  slug: builder-api
+  order: 5
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: builder_api.md

docs/pydoc/config-preview/caching.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/components/caching]
+    modules: ["url_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: renderers.ReadmePreviewRenderer
+  excerpt: Checks if any document coming from the given URL is already present in the store.
+  category_slug: haystack-classes
+  title: UrlCacheChecker API
+  slug: caching-api
+  order: 160
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: caching_api.md

docs/pydoc/config-preview/classifier.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/components/classifiers]
+    modules: ["document_language_classifier", "text_language_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: renderers.ReadmePreviewRenderer
+  excerpt: Detects the language of the Documents and routes them appropriately.
+  category_slug: haystack-classes
+  title: Language Classifier API
+  slug: language-classifier-api
+  order: 10
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: language_classifier_api.md

docs/pydoc/config-preview/document_store.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/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: renderers.ReadmePreviewRenderer
+  excerpt: Stores your texts and meta data and provides them to the Retriever at query time.
+  category_slug: haystack-classes
+  title: DocumentStore API
+  slug: document-store-api
+  order: 20
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: document_store.md

docs/pydoc/config-preview/embedder.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/components/embedders]
+    modules: ["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: renderers.ReadmePreviewRenderer
+  excerpt: Transforms queries into vectors to look for similar or relevant Documents.
+  category_slug: haystack-classes
+  title: Embedder API
+  slug: embedder-api
+  order: 40
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: embedder_api.md

docs/pydoc/config-preview/fetcher.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/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: renderers.ReadmePreviewRenderer
+  excerpt: Fetches content from a list of URLs and returns a list of extracted content streams.
+  category_slug: haystack-classes
+  title: LinkContentFetcher API
+  slug: fetcher-api
+  order: 70
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: fetcher_api.md

docs/pydoc/config-preview/file_converter.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/components/file_converters]
+    modules: ["azure", "html", "markdown", "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: renderers.ReadmePreviewRenderer
+  excerpt: Extracts text from files in different formats and converts it into the unified Document format.
+  category_slug: haystack-classes
+  title: File Converter API
+  slug: file-converter-api
+  order: 50
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: file_converter_api.md

docs/pydoc/config-preview/generator.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/components/generators]
+    modules: ["hugging_face_local", "hugging_face_tgi", "openai", "chat/hugging_face_tgi", "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: renderers.ReadmePreviewRenderer
+  excerpt: Enables text generation using LLMs.
+  category_slug: haystack-classes
+  title: Generator API
+  slug: generator-api
+  order: 60
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: generator_api.md

docs/pydoc/config-preview/pipeline.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview]
+    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: renderers.ReadmePreviewRenderer
+  excerpt: Arranges components and integrations in flow.
+  category_slug: haystack-classes
+  title: Pipelines API
+  slug: pipelines-api
+  order: 80
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: pipelines_api.md

docs/pydoc/config-preview/preprocessor.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/components/preprocessors]
+    modules: ["document_cleaner", "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: renderers.ReadmePreviewRenderer
+  excerpt: Normalizes white spaces, gets rid of headers and footers, cleans empty lines in your Documents, or splits them into smaller pieces.
+  category_slug: haystack-classes
+  title: PreProcessor API
+  slug: preprocessor-api
+  order: 90
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: preprocessor_api.md

docs/pydoc/config-preview/ranker.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/components/rankers]
+    modules: ["meta_field", "transformers_similarity"]
+    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: renderers.ReadmePreviewRenderer
+  excerpt: Reorders a set of Documents based on their relevance to the query.
+  category_slug: haystack-classes
+  title: Ranker API
+  slug: ranker-api
+  order: 110
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: ranker_api.md

docs/pydoc/config-preview/reader.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/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: renderers.ReadmePreviewRenderer
+  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-classes
+  title: Reader API
+  slug: reader-api
+  order: 120
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: reader_api.md

docs/pydoc/config-preview/retriever.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/components/retrievers]
+    modules: ["in_memory_bm25_retriever", "in_memory_embedding_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: renderers.ReadmePreviewRenderer
+  excerpt: Sweeps through a Document Store and returns a set of candidate Documents that are relevant to the query.
+  category_slug: haystack-classes
+  title: Retriever API
+  slug: retriever-api
+  order: 130
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: retriever_api.md

docs/pydoc/config-preview/router.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/components/routers]
+    modules: ["file_type_router", "metadata_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: renderers.ReadmePreviewRenderer
+  excerpt: Routes data to the right component based on its file type or metadata.
+  category_slug: haystack-classes
+  title: Router API
+  slug: router-api
+  order: 140
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: router_api.md

docs/pydoc/config-preview/sampler.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/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: renderers.ReadmePreviewRenderer
+  excerpt: Filters documents based on their similarity scores using top-p sampling.
+  category_slug: haystack-classes
+  title: TopPSampler API
+  slug: sampler-api
+  order: 150
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: sampler_api.md

docs/pydoc/config-preview/websearch.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/components/websearch]
+    modules: ["serper_dev"]
+    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: renderers.ReadmePreviewRenderer
+  excerpt: Web search engine for Haystack.
+  category_slug: haystack-classes
+  title: Websearch API
+  slug: websearch-api
+  order: 170
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: websearch_api.md

docs/pydoc/config-preview/whisper.yml

@@ -1,7 +1,7 @@
 loaders:
   - type: loaders.CustomPythonLoader
     search_path: [../../../haystack/preview/components/audio]
-    modules: ["whisper_local"]
+    modules: ["whisper_local", "whisper_remote"]
     ignore_when_discovered: ["__init__"]
 processors:
   - type: filter
@@ -13,14 +13,14 @@ processors:
   - type: crossref
 renderer:
   type: renderers.ReadmePreviewRenderer
-  excerpt: LocalWhisperTranscriber transcribes audio files using OpenAI's Whisper models on your local machine
+  excerpt: Transcribes audio files.
   category_slug: haystack-classes
-  title: LocalWhisperTranscriber API
-  slug: local-whisper-transcriber-api
-  order: 10
+  title: WhisperTranscriber API
+  slug: whisper-transcriber-api
+  order: 180
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: local_whisper_transcriber_api.md
+    filename: whisper_transcriber_api.md

docs/pydoc/config-preview/writer.yml

@@ -0,0 +1,26 @@
+loaders:
+  - type: loaders.CustomPythonLoader
+    search_path: [../../../haystack/preview/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: renderers.ReadmePreviewRenderer
+  excerpt: Writes Documents to a DocumentStore.
+  category_slug: haystack-classes
+  title: DocumentWriter API
+  slug: writer-api
+  order: 30
+  markdown:
+    descriptive_class_title: false
+    descriptive_module_title: true
+    add_method_class_prefix: true
+    add_member_class_prefix: false
+    filename: writer_api.md