chore: migrate to canals==0.7.0

haystack/preview/__init__.py

@@ -1,2 +1,3 @@
 from canals import component, Pipeline
+from canals.serialization import default_from_dict, default_to_dict, DeserializationError
 from haystack.preview.dataclasses import *

haystack/preview/components/audio/whisper_local.py

@@ -55,6 +55,19 @@ def warm_up(self) -> None:
         if not self._model:
             self._model = whisper.load_model(self.model_name, device=self.device)
 
+    def to_dict(self) -> Dict[str, Any]:
+        """
+        Serialize this component to a dictionary.
+        """
+        # return default_to_dict(self, model_name_or_path=self.model_name, device=self.device, whisper_params=self.whisper_params)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "LocalWhisperTranscriber":
+        """
+        Deserialize this component from a dictionary.
+        """
+        # return default_from_dict(cls, data)
+
     @component.output_types(documents=List[Document])
     def run(self, audio_files: List[Path], whisper_params: Optional[Dict[str, Any]] = None):
         """

haystack/preview/components/audio/whisper_remote.py

@@ -49,17 +49,23 @@ def __init__(
         if not api_key:
             raise ValueError("API key is None.")
 
+        self.model_name = model_name
         self.api_key = api_key
         self.api_base = api_base
         self.whisper_params = whisper_params or {}
 
-        self.model_name = model_name
-        self.init_parameters = {
-            "api_key": self.api_key,
-            "model_name": self.model_name,
-            "api_base": self.api_base,
-            "whisper_params": self.whisper_params,
-        }
+    def to_dict(self) -> Dict[str, Any]:
+        """
+        Serialize this component to a dictionary.
+        """
+        # return default_to_dict(self, model_name=self.model_name, api_key=self.api_key, api_base=self.api_base, whisper_params=self.whisper_params)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "RemoteWhisperTranscriber":
+        """
+        Deserialize this component from a dictionary.
+        """
+        # return default_from_dict(cls, data)
 
     @component.output_types(documents=List[Document])
     def run(self, audio_files: List[Path], whisper_params: Optional[Dict[str, Any]] = None):

haystack/preview/components/classifiers/file_classifier.py

@@ -2,7 +2,7 @@
 import mimetypes
 from collections import defaultdict
 from pathlib import Path
-from typing import List, Union, Optional
+from typing import List, Union, Optional, Dict, Any
 
 from haystack.preview import component
 
@@ -44,6 +44,19 @@ def __init__(self, mime_types: List[str]):
         component.set_output_types(self, unclassified=List[Path], **{mime_type: List[Path] for mime_type in mime_types})
         self.mime_types = mime_types
 
+    def to_dict(self) -> Dict[str, Any]:
+        """
+        Serialize this component to a dictionary.
+        """
+        # return default_to_dict(self, model_name_or_path=self.model_name, device=self.device, whisper_params=self.whisper_params)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "FileExtensionClassifier":
+        """
+        Deserialize this component from a dictionary.
+        """
+        # return default_from_dict(cls, data)
+
     def run(self, paths: List[Union[str, Path]]):
         """
         Run the FileExtensionClassifier.

haystack/preview/components/embedders/sentence_transformers_document_embedder.py

@@ -1,4 +1,4 @@
-from typing import List, Optional, Union
+from typing import List, Optional, Union, Dict, Any
 
 from haystack.preview import component
 from haystack.preview import Document
@@ -50,6 +50,19 @@ def __init__(
         self.metadata_fields_to_embed = metadata_fields_to_embed or []
         self.embedding_separator = embedding_separator
 
+    def to_dict(self) -> Dict[str, Any]:
+        """
+        Serialize this component to a dictionary.
+        """
+        # return default_to_dict(self, ...)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "SentenceTransformersDocumentEmbedder":
+        """
+        Deserialize this component from a dictionary.
+        """
+        # return default_from_dict(cls, data)
+
     def warm_up(self):
         """
         Load the embedding backend.

haystack/preview/components/embedders/sentence_transformers_text_embedder.py

@@ -1,4 +1,4 @@
-from typing import List, Optional, Union
+from typing import List, Optional, Union, Dict, Any
 
 from haystack.preview import component
 from haystack.preview.embedding_backends.sentence_transformers_backend import (
@@ -48,6 +48,19 @@ def __init__(
         self.progress_bar = progress_bar
         self.normalize_embeddings = normalize_embeddings
 
+    def to_dict(self) -> Dict[str, Any]:
+        """
+        Serialize this component to a dictionary.
+        """
+        # return default_to_dict(self, ...)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "SentenceTransformersTextEmbedder":
+        """
+        Deserialize this component from a dictionary.
+        """
+        # return default_from_dict(cls, data)
+
     def warm_up(self):
         """
         Load the embedding backend.

haystack/preview/components/file_converters/txt.py

@@ -1,6 +1,6 @@
 import logging
 from pathlib import Path
-from typing import Optional, List, Union, Dict
+from typing import Optional, List, Union, Dict, Any
 
 from canals.errors import PipelineRuntimeError
 from tqdm import tqdm
@@ -61,6 +61,19 @@ def __init__(
         self.id_hash_keys = id_hash_keys or []
         self.progress_bar = progress_bar
 
+    def to_dict(self) -> Dict[str, Any]:
+        """
+        Serialize this component to a dictionary.
+        """
+        # return default_to_dict(self, ...)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "TextFileToDocument":
+        """
+        Deserialize this component from a dictionary.
+        """
+        # return default_from_dict(cls, data)
+
     @component.output_types(documents=List[Document])
     def run(
         self,

haystack/preview/components/retrievers/memory.py

@@ -41,6 +41,19 @@ def __init__(
         self.top_k = top_k
         self.scale_score = scale_score
 
+    def to_dict(self) -> Dict[str, Any]:
+        """
+        Serialize this component to a dictionary.
+        """
+        # return default_to_dict(self, ...)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "MemoryRetriever":
+        """
+        Deserialize this component from a dictionary.
+        """
+        # return default_from_dict(cls, data)
+
     @component.output_types(documents=List[List[Document]])
     def run(
         self,

haystack/preview/components/writers/document_writer.py

@@ -1,4 +1,4 @@
-from typing import List, Optional
+from typing import List, Optional, Dict, Any
 
 from haystack.preview import component, Document
 from haystack.preview.document_stores import DocumentStore, DuplicatePolicy
@@ -19,6 +19,19 @@ def __init__(self, document_store: DocumentStore, policy: DuplicatePolicy = Dupl
         self.document_store = document_store
         self.policy = policy
 
+    def to_dict(self) -> Dict[str, Any]:
+        """
+        Serialize this component to a dictionary.
+        """
+        # return default_to_dict(self, ...)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "DocumentWriter":
+        """
+        Deserialize this component from a dictionary.
+        """
+        # return default_from_dict(cls, data)
+
     def run(self, documents: List[Document], policy: Optional[DuplicatePolicy] = None):
         """
         Run DocumentWriter on the given input data.

pyproject.toml

@@ -80,7 +80,7 @@ dependencies = [
   "jsonschema",
 
   # Preview
-  "canals==0.5.0",
+  "canals==0.7.0",
 
   # Agent events
   "events",

releasenotes/notes/default-to-from-dict-7f7d89b6c36e2ab8.yaml

@@ -0,0 +1,4 @@
+---
+preview:
+  - Migrate all components to Canals==0.7.0
+  - Add serialization and deserialization methods for all Haystack components