changes requested

deepset-ai · Apr 5, 2024 · e467feb · e467feb
1 parent 14cedf4
commit e467feb
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 7 deletions.
diff --git a/haystack/components/embedders/hugging_face_api_text_embedder.py b/haystack/components/embedders/hugging_face_api_text_embedder.py
@@ -17,9 +17,9 @@
 class HuggingFaceAPITextEmbedder:
     """
     This component can be used to embed strings using different Hugging Face APIs:
-    - [free Serverless Inference API]((https://huggingface.co/inference-api)
-    - [paid Inference Endpoints](https://huggingface.co/inference-endpoints)
-    - [self-hosted Text Embeddings Inference](https://github.com/huggingface/text-embeddings-inference)
+    - [Free Serverless Inference API]((https://huggingface.co/inference-api)
+    - [Paid Inference Endpoints](https://huggingface.co/inference-endpoints)
+    - [Self-hosted Text Embeddings Inference](https://github.com/huggingface/text-embeddings-inference)
 
 
     Example usage with the free Serverless Inference API:
@@ -65,8 +65,8 @@ class HuggingFaceAPITextEmbedder:
 
     def __init__(
         self,
-        api_type: Union[HFEmbeddingAPIType, str] = HFEmbeddingAPIType.SERVERLESS_INFERENCE_API,
-        api_params: Optional[Dict[str, str]] = None,
+        api_type: Union[HFEmbeddingAPIType, str],
+        api_params: Dict[str, str],
         token: Optional[Secret] = Secret.from_env_var("HF_API_TOKEN", strict=False),
         prefix: str = "",
         suffix: str = "",
@@ -104,8 +104,6 @@ def __init__(
         if isinstance(api_type, str):
             api_type = HFEmbeddingAPIType.from_str(api_type)
 
-        api_params = api_params or {}
-
         if api_type == HFEmbeddingAPIType.SERVERLESS_INFERENCE_API:
             model = api_params.get("model")
             if model is None:

diff --git a/haystack/utils/hf.py b/haystack/utils/hf.py
@@ -26,8 +26,13 @@ class HFEmbeddingAPIType(Enum):
     API type to use for Hugging Face API Embedders.
     """
 
+    # HF [Text Embeddings Inference (TEI)](https://github.com/huggingface/text-embeddings-inference).
     TEXT_EMBEDDINGS_INFERENCE = "text_embeddings_inference"
+
+    # HF [Inference Endpoints](https://huggingface.co/inference-endpoints).
     INFERENCE_ENDPOINTS = "inference_endpoints"
+
+    # HF [Serverless Inference API](https://huggingface.co/inference-api).
     SERVERLESS_INFERENCE_API = "serverless_inference_api"
 
     def __str__(self):