mirror of
https://github.com/deepset-ai/haystack.git
synced 2025-07-23 08:52:16 +00:00
3deaa20cb6
* 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>
35 lines
1010 B
YAML
35 lines
1010 B
YAML
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
|