docs: discourage usage of HuggingFaceAPIGenerator with the HF Inference API

[anakin87]

Related Issues

• fixes HuggingFaceAPIGenerator is not working #9586

The idea of using chat_completion method in the HuggingFaceAPIGenerator has been abandoned because:

• it would create duplication with the HuggingFaceAPIChatGenerator
• it would make the component usage less transparent and intuitive
• this component still works well with HF Inference Endpoints and TGI - using text_generation

Proposed Changes:

• I want to convey this message: "To generate text with the HF Inference API, use the HuggingFaceAPIChatGenerator"
  • modified docstrings
  • added a warning
  • explained what happened in the release notes

Notes for the reviewer

For now, I have decided not to deprecate the usage of SERVERLESS_INFERENCE_API in this component because, as there is no official communication, I am not sure if they will not re-enable this option in the future.

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

[coveralls]

Pull Request Test Coverage Report for Build 16075800688

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• 3 unchanged lines in 1 file lost coverage.
• Overall coverage increased (+0.001%) to 90.433%

---

Files with Coverage Reduction	New Missed Lines	%
components/generators/hugging_face_api.py	3	96.51%

Totals
Change from base Build 16068517356:	0.001%
Covered Lines:	11684
Relevant Lines:	12920

---

💛 - Coveralls

[dfokina]

Some language suggestions

[sjrl]

Looks good to me!