haystack/docs/pydoc/config/rankers_api.yml

loaders:
  - type: haystack_pydoc_tools.loaders.CustomPythonLoader
    search_path: [../../../haystack/components/rankers]
    modules: [
      "hugging_face_tei",
      "lost_in_the_middle",
      "meta_field",
      "meta_field_grouping_ranker",
      "sentence_transformers_diversity",
      "sentence_transformers_similarity",
      "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: 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
docs: Add readme sync for API docs 2.0 (#6173) * add sync docs for preview * add example config for audio docs * hardcode version in renderer * use custom renderer for preview docs * update comment and excerpt 2023-10-27 14:53:03 +02:00			`loaders:`
use haystack-pydoc-tools package instead of local code (#6818) 2024-01-23 18:28:52 +01:00			`- type: haystack_pydoc_tools.loaders.CustomPythonLoader`
docs: add Data Classes API ref and cleanup (#6482) * Data Classes and cleanup * Update pydoc-markdown.sh * Update converter.yml 2023-12-04 14:03:28 +01:00			`search_path: [../../../haystack/components/rankers]`
feat: Add HuggingFace API (text-embeddings-inference for rerank model) for component.rankers (#9414) * feat(component.rankers): Add HuggingFace API (text-embeddings-inference for rerank) ranker component * update test flow & doc loaders * Support run_async for HuggingFaceAPIRanker * Add release note for HuggingFace API support in component.rankers * Add release note for HuggingFace API support in component.rankers * Add release note for HuggingFace API support in component.rankers * Add release note for HuggingFace API support in component.rankers * fix: 1. `hugging_face_api.HuggingFaceAPIRanker` rename to `hugging_face_tei.HuggingFaceAPIRanker` 2. HuggingFaceAPIRanker: use our Secret API for token 3. add the missing modules for `docs/pydoc/config/rankers_api.yml` 4. added function `async_request_with_retry` for `haystack/utils/requests_utils.py` and added unittest on `test/utils/test_requests_utils.py` 4. HuggingFaceAPIRanker: refactor the retry function to support configuration based on attempts and status code. 5. HuggingFaceAPIRanker: refactor the test into unit tests using mocks * fix(HuggingFaceTEIRanker): change the token check logic to use the resolve_value method. * fix(format): run `hatch run format` * fix: - Force keyword-only arguments in __init__ method by adding , - Clarify token docstring that it's not always required - Copy documents to avoid modifying original objects - Remove test file from slow workflow - Add monkeypatch eånvironment variable cleanup in tests - Fix missing module in rankers_api.yml and sort modules alphabetically - Remove unnecessary test info from release notes fix HuggingFaceTEIRanker： - "None" of "Optional[Secret]" has no attribute "resolve_value" - run/run_async: too many parameters * fix(HuggingFaceTEIRanker) :Revise the docstring of the HuggingFaceTEIRanker, improve the parameter descriptions, ensure consistency and clarity. Add error handling information to enhance the readability of the API response. * fix：unit test for HuggingFaceTEIRanker raise message * fix fmt * minor refinements * refine release note --------- Co-authored-by: anakin87 <stefanofiorucci@gmail.com> 2025-05-27 18:44:54 +08:00			`modules: [`
			`"hugging_face_tei",`
			`"lost_in_the_middle",`
			`"meta_field",`
			`"meta_field_grouping_ranker",`
			`"sentence_transformers_diversity",`
			`"sentence_transformers_similarity",`
			`"transformers_similarity"]`
docs: Add readme sync for API docs 2.0 (#6173) * add sync docs for preview * add example config for audio docs * hardcode version in renderer * use custom renderer for preview docs * update comment and excerpt 2023-10-27 14:53:03 +02:00			`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:`
Update docs renderer (#7349) 2024-03-13 12:30:13 +01:00			`type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer`
docs: 2.0 API reference (#6262) * docs: 2.0 API reference * add builders and generators * classifiers file path 2023-11-14 10:12:28 +01:00			`excerpt: Reorders a set of Documents based on their relevance to the query.`
chore: rename categories in the API docs (#6885) * rename API categories * fix * update slugs * rename files for consistency * fix category ID * try getting the right version 2024-02-01 16:47:26 +01:00			`category_slug: haystack-api`
			`title: Rankers`
			`slug: rankers-api`
docs: 2.0 API reference (#6262) * docs: 2.0 API reference * add builders and generators * classifiers file path 2023-11-14 10:12:28 +01:00			`order: 110`
docs: Add readme sync for API docs 2.0 (#6173) * add sync docs for preview * add example config for audio docs * hardcode version in renderer * use custom renderer for preview docs * update comment and excerpt 2023-10-27 14:53:03 +02:00			`markdown:`
			`descriptive_class_title: false`
docs: disable class def rendering (#7329) 2024-03-07 15:54:16 +01:00			`classdef_code_block: false`
docs: Add readme sync for API docs 2.0 (#6173) * add sync docs for preview * add example config for audio docs * hardcode version in renderer * use custom renderer for preview docs * update comment and excerpt 2023-10-27 14:53:03 +02:00			`descriptive_module_title: true`
			`add_method_class_prefix: true`
			`add_member_class_prefix: false`
chore: rename categories in the API docs (#6885) * rename API categories * fix * update slugs * rename files for consistency * fix category ID * try getting the right version 2024-02-01 16:47:26 +01:00			`filename: rankers_api.md`