feat: Add HuggingFace API (text-embeddings-inference for rerank model) for component.rankers #9414

atopx · 2025-05-20T14:12:31Z

Add HuggingFace API (text-embeddings-inference for rerank model)

Proposed Changes:

How did you test it?

Unit tests have been added in test/components/rankers/test_hugging_face_api.py

Notes for the reviewer

Running unit tests requires setting up the text-embeddings-inference service and running the reranker model BAAI/bge-reranker-v2-m3

Checklist

I have read the contributors guidelines and the code of conduct
I have updated the related issue with new insights and changes
I added unit tests and updated the docstrings
I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
I documented my code
I ran pre-commit hooks and fixed any issue

…ce for rerank) ranker component

CLAassistant · 2025-05-20T14:13:00Z

All committers have signed the CLA.

vblagoje · 2025-05-21T08:54:22Z

Hey @atopx thanks for your effort, have a look at contributing guide - you need to add reno note to this PR. We use it to generate beautiful release notes for Haystack 🙏

atopx · 2025-05-21T12:41:22Z

Hey @atopx thanks for your effort, have a look at contributing guide - you need to add reno note to this PR. We use it to generate beautiful release notes for Haystack 🙏

reno note added: releasenotes/notes/add-huggingface-api-text-embeddings-inference-to-component-rankers-0e3f54e523e42141.yaml

# Conflicts: # docs/pydoc/config/rankers_api.yml

vblagoje · 2025-05-23T07:47:28Z

Hey @atopx this looks good. Please note that we can't serialize tokens directly as that is sensitive info and we have to use our Secret API This will take you 5 min to update 🙏

@anakin87 just to confirm, we don't have these HF remote rankers already somewhere? Is this a good direction in general. TIA

docs/pydoc/config/rankers_api.yml

haystack/components/rankers/hugging_face_api.py

test/components/rankers/test_hugging_face_api.py

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

…solve_value method.

anakin87

Thanks for your work!
I found some opportunities for further improvement.

@dfokina could you please take a look at the docstrings?

.github/workflows/slow.yml

docs/pydoc/config/rankers_api.yml

haystack/components/rankers/hugging_face_tei.py

...tes/add-huggingface-api-text-embeddings-inference-to-component-rankers-0e3f54e523e42141.yaml

test/components/rankers/test_hugging_face_tei.py

- 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

coveralls · 2025-05-23T11:42:13Z

Pull Request Test Coverage Report for Build 15270742072

Details

0 of 0 changed or added relevant lines in 0 files are covered.
2 unchanged lines in 1 file lost coverage.
Overall coverage increased (+0.2%) to 90.374%

Files with Coverage Reduction	New Missed Lines	%
components/rankers/init.py	2	46.15%

Totals
Change from base Build 15269350331:	0.2%
Covered Lines:	11491
Relevant Lines:	12715

💛 - Coveralls

- "None" of "Optional[Secret]" has no attribute "resolve_value" - run/run_async: too many parameters

anakin87

This PR looks in a good state.

I would like to do some local tests (and refine the docstrings). I think I can do that next week.

@atopx, in the meantime, thanks for all the good work!

dfokina

Leaving some suggestions from the writing perspective.

haystack/components/rankers/hugging_face_tei.py

…Ranker, improve the parameter descriptions, ensure consistency and clarity. Add error handling information to enhance the readability of the API response.

atopx · 2025-05-25T05:04:30Z

Leaving some suggestions from the writing perspective.

Thank you for pointing that out!

anakin87 · 2025-05-27T08:48:11Z

In e80f814, I made some minor refinements, mostly to make it clear that this component works both with:

self-hosted TEI service
Hugging Face Inference Endpoints

(I also tried it manually).

@dfokina could you take a final look at docstrings after my last changes?

dfokina

LGTM!

anakin87

@atopx thanks for this good work! 🥳

I'm merging this PR now...

feat(component.rankers): Add HuggingFace API (text-embeddings-inferen…

df25fe2

…ce for rerank) ranker component

atopx requested a review from a team as a code owner May 20, 2025 14:12

atopx requested review from vblagoje and removed request for a team May 20, 2025 14:12

github-actions bot added topic:tests topic:DX Developer Experience type:documentation Improvements on the docs labels May 20, 2025

update test flow & doc loaders

9f12090

github-actions bot added the topic:CI label May 20, 2025

Support run_async for HuggingFaceAPIRanker

71192d6

Add release note for HuggingFace API support in component.rankers

670523d

atopx requested a review from a team as a code owner May 21, 2025 12:20

atopx requested review from dfokina and removed request for a team May 21, 2025 12:20

atopx added 3 commits May 21, 2025 20:32

Add release note for HuggingFace API support in component.rankers

ddc2aad

Add release note for HuggingFace API support in component.rankers

35da7ea

Add release note for HuggingFace API support in component.rankers

ace8b4c

atopx and others added 2 commits May 21, 2025 20:52

Merge remote-tracking branch 'upstream/main'

bd5e317

# Conflicts: # docs/pydoc/config/rankers_api.yml

Merge branch 'main' into main

2ffc4b3

anakin87 requested changes May 23, 2025

View reviewed changes

atopx and others added 2 commits May 23, 2025 16:29

Merge branch 'main' into main

1ebc6f1

atopx requested a review from anakin87 May 23, 2025 10:31

atopx added 2 commits May 23, 2025 18:37

fix(HuggingFaceTEIRanker): change the token check logic to use the re…

aa5348b

…solve_value method.

fix(format): run hatch run format

75a2d69

anakin87 requested changes May 23, 2025

View reviewed changes

atopx and others added 2 commits May 23, 2025 19:19

Merge branch 'main' into main

66a4c16

atopx requested a review from anakin87 May 23, 2025 11:20

anakin87 self-assigned this May 23, 2025

atopx and others added 3 commits May 23, 2025 21:06

fix HuggingFaceTEIRanker：

976b8ac

- "None" of "Optional[Secret]" has no attribute "resolve_value" - run/run_async: too many parameters

Merge branch 'main' into main

30d0d05

Merge branch 'main' into main

243b3f7

anakin87 reviewed May 23, 2025

View reviewed changes

dfokina requested changes May 23, 2025

View reviewed changes

atopx and others added 2 commits May 25, 2025 13:00

fix(HuggingFaceTEIRanker) :Revise the docstring of the HuggingFaceTEI…

bc9529e

…Ranker, improve the parameter descriptions, ensure consistency and clarity. Add error handling information to enhance the readability of the API response.

Merge branch 'main' into main

91aa51f

atopx requested a review from dfokina May 25, 2025 05:04

atopx and others added 7 commits May 26, 2025 18:07

fix：unit test for HuggingFaceTEIRanker raise message

d028977

Merge branch 'main' of github.com:atopx/haystack

d6d1b68

Merge branch 'main' into main

0b4043e

Merge branch 'main' into tei-ranker

542b472

fix fmt

6f2569b

minor refinements

e80f814

refine release note

a88e2f2

dfokina approved these changes May 27, 2025

View reviewed changes

anakin87 approved these changes May 27, 2025

View reviewed changes

anakin87 merged commit 3deaa20 into deepset-ai:main May 27, 2025
22 checks passed

anakin87 mentioned this pull request May 27, 2025

Add docs for HuggingFaceTEIRanker #9450

Closed

feat: Add HuggingFace API (text-embeddings-inference for rerank model) for component.rankers #9414

feat: Add HuggingFace API (text-embeddings-inference for rerank model) for component.rankers #9414

Uh oh!

Conversation

atopx commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed Changes:

How did you test it?

Notes for the reviewer

Checklist

Uh oh!

CLAassistant commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vblagoje commented May 21, 2025

Uh oh!

atopx commented May 21, 2025

Uh oh!

vblagoje commented May 23, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anakin87 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coveralls commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 15270742072

Details

💛 - Coveralls

Uh oh!

anakin87 left a comment

Choose a reason for hiding this comment

Uh oh!

dfokina left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

atopx commented May 25, 2025

Uh oh!

anakin87 commented May 27, 2025

Uh oh!

dfokina left a comment

Choose a reason for hiding this comment

Uh oh!

anakin87 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

atopx commented May 20, 2025 •

edited

Loading

CLAassistant commented May 20, 2025 •

edited

Loading

coveralls commented May 23, 2025 •

edited

Loading

dfokina left a comment •

edited

Loading