fix broken serialization of HFAPI components (#7661)

deepset-ai · May 8, 2024 · 7c9532b · 7c9532b
1 parent 9446714
commit 7c9532b
Show file tree

Hide file tree

Showing 9 changed files with 13 additions and 8 deletions.
diff --git a/haystack/components/embedders/hugging_face_api_document_embedder.py b/haystack/components/embedders/hugging_face_api_document_embedder.py
@@ -175,7 +175,7 @@ def to_dict(self) -> Dict[str, Any]:
  """
  return default_to_dict(
  self,
- api_type=self.api_type,
+ api_type=str(self.api_type),
  api_params=self.api_params,
  prefix=self.prefix,
  suffix=self.suffix,

diff --git a/haystack/components/embedders/hugging_face_api_text_embedder.py b/haystack/components/embedders/hugging_face_api_text_embedder.py
@@ -142,7 +142,7 @@ def to_dict(self) -> Dict[str, Any]:
  """
  return default_to_dict(
  self,
- api_type=self.api_type,
+ api_type=str(self.api_type),
  api_params=self.api_params,
  prefix=self.prefix,
  suffix=self.suffix,

diff --git a/haystack/components/generators/chat/hugging_face_api.py b/haystack/components/generators/chat/hugging_face_api.py
@@ -158,7 +158,7 @@ def to_dict(self) -> Dict[str, Any]:
  callback_name = serialize_callable(self.streaming_callback) if self.streaming_callback else None
  return default_to_dict(
  self,
- api_type=self.api_type,
+ api_type=str(self.api_type),
  api_params=self.api_params,
  token=self.token.to_dict() if self.token else None,
  generation_kwargs=self.generation_kwargs,

diff --git a/haystack/components/generators/hugging_face_api.py b/haystack/components/generators/hugging_face_api.py
@@ -142,7 +142,7 @@ def to_dict(self) -> Dict[str, Any]:
  callback_name = serialize_callable(self.streaming_callback) if self.streaming_callback else None
  return default_to_dict(
  self,
- api_type=self.api_type,
+ api_type=str(self.api_type),
  api_params=self.api_params,
  token=self.token.to_dict() if self.token else None,
  generation_kwargs=self.generation_kwargs,

diff --git a/releasenotes/notes/fix-hf-api-serialization-026b84de29827c57.yaml b/releasenotes/notes/fix-hf-api-serialization-026b84de29827c57.yaml
@@ -0,0 +1,5 @@
+---
+fixes:
+ - |
+ Fix the broken serialization of HuggingFaceAPITextEmbedder, HuggingFaceAPIDocumentEmbedder,
+ HuggingFaceAPIGenerator, and HuggingFaceAPIChatGenerator.
diff --git a/test/components/embedders/test_hugging_face_api_document_embedder.py b/test/components/embedders/test_hugging_face_api_document_embedder.py
@@ -109,7 +109,7 @@ def test_to_dict(self, mock_check_valid_model):
  assert data == {
  "type": "haystack.components.embedders.hugging_face_api_document_embedder.HuggingFaceAPIDocumentEmbedder",
  "init_parameters": {
- "api_type": HFEmbeddingAPIType.SERVERLESS_INFERENCE_API,
+ "api_type": "serverless_inference_api",
  "api_params": {"model": "BAAI/bge-small-en-v1.5"},
  "token": {"env_vars": ["HF_API_TOKEN"], "strict": False, "type": "env_var"},
  "prefix": "prefix",

diff --git a/test/components/embedders/test_hugging_face_api_text_embedder.py b/test/components/embedders/test_hugging_face_api_text_embedder.py
@@ -95,7 +95,7 @@ def test_to_dict(self, mock_check_valid_model):
  assert data == {
  "type": "haystack.components.embedders.hugging_face_api_text_embedder.HuggingFaceAPITextEmbedder",
  "init_parameters": {
- "api_type": HFEmbeddingAPIType.SERVERLESS_INFERENCE_API,
+ "api_type": "serverless_inference_api",
  "api_params": {"model": "BAAI/bge-small-en-v1.5"},
  "token": {"env_vars": ["HF_API_TOKEN"], "strict": False, "type": "env_var"},
  "prefix": "prefix",

diff --git a/test/components/generators/chat/test_hugging_face_api.py b/test/components/generators/chat/test_hugging_face_api.py
@@ -138,7 +138,7 @@ def test_to_dict(self, mock_check_valid_model):
  result = generator.to_dict()
  init_params = result["init_parameters"]
 
- assert init_params["api_type"] == HFGenerationAPIType.SERVERLESS_INFERENCE_API
+ assert init_params["api_type"] == "serverless_inference_api"
  assert init_params["api_params"] == {"model": "HuggingFaceH4/zephyr-7b-beta"}
  assert init_params["token"] == {"env_vars": ["ENV_VAR"], "strict": False, "type": "env_var"}
  assert init_params["generation_kwargs"] == {"temperature": 0.6, "stop": ["stop", "words"], "max_tokens": 512}

diff --git a/test/components/generators/test_hugging_face_api.py b/test/components/generators/test_hugging_face_api.py
@@ -131,7 +131,7 @@ def test_to_dict(self, mock_check_valid_model):
  result = generator.to_dict()
  init_params = result["init_parameters"]
 
- assert init_params["api_type"] == HFGenerationAPIType.SERVERLESS_INFERENCE_API
+ assert init_params["api_type"] == "serverless_inference_api"
  assert init_params["api_params"] == {"model": "HuggingFaceH4/zephyr-7b-beta"}
  assert init_params["token"] == {"env_vars": ["ENV_VAR"], "strict": False, "type": "env_var"}
  assert init_params["generation_kwargs"] == {