fastembed-haystack 1.4.0__tar.gz → 1.5.0__tar.gz

fastembed_haystack-1.5.0/CHANGELOG.md

@@ -0,0 +1,130 @@
+# Changelog
+
+## [integrations/fastembed-v1.4.1] - 2024-11-19
+
+### 🌀 Miscellaneous
+
+- Add new example with the ranker and fix the old ones (#1198)
+- Fix: Fastembed - Change default Sparse model as the used one is deprecated due to a typo (#1201)
+
+## [integrations/fastembed-v1.4.0] - 2024-11-13
+
+### ⚙️ CI
+
+- Adopt uv as installer (#1142)
+
+### 🌀 Miscellaneous
+
+- Chore: fastembed - pin `onnxruntime<1.20.0` (#1164)
+- Feat: Fastembed - add FastembedRanker (#1178)
+
+## [integrations/fastembed-v1.3.0] - 2024-10-07
+
+### 🚀 Features
+
+- Introduce `model_kwargs` in Sparse Embedders (can be used for BM25 parameters) (#1126)
+
+### 🧪 Testing
+
+- Do not retry tests in `hatch run test` command (#954)
+
+### ⚙️ CI
+
+- Retry tests to reduce flakyness (#836)
+
+### 🧹 Chores
+
+- Update ruff invocation to include check parameter (#853)
+- Update ruff linting scripts and settings (#1105)
+
+### 🌀 Miscellaneous
+
+- Ci: install `pytest-rerunfailures` where needed; add retry config to `test-cov` script (#845)
+- Typo on Sparse embedders. The parameter should be "progress_bar" … (#814)
+- Chore: fastembed - ruff update, don't ruff tests (#997)
+
+## [integrations/fastembed-v1.1.0] - 2024-05-15
+
+### 🌀 Miscellaneous
+
+- Chore: change the pydoc renderer class (#718)
+- Use the local_files_only option available as of fastembed==0.2.7. It … (#736)
+
+## [integrations/fastembed-v1.0.0] - 2024-05-06
+
+### 🌀 Miscellaneous
+
+- Chore: add license classifiers (#680)
+- `FastembedSparseTextEmbedder` - remove `batch_size` (#688)
+
+## [integrations/fastembed-v0.1.0] - 2024-04-10
+
+### 🚀 Features
+
+- *(FastEmbed)* Support for SPLADE Sparse Embedder (#579)
+
+### 📚 Documentation
+
+- Disable-class-def (#556)
+
+### 🌀 Miscellaneous
+
+- Remove references to Python 3.7 (#601)
+
+## [integrations/fastembed-v0.0.6] - 2024-03-07
+
+### 📚 Documentation
+
+- Review and normalize docstrings - `integrations.fastembed` (#519)
+- Small consistency improvements (#536)
+
+### 🌀 Miscellaneous
+
+- Docs: Fix `integrations.fastembed` API docs (#540)
+- Improvements to FastEmbed integration (#558)
+
+## [integrations/fastembed-v0.0.5] - 2024-02-20
+
+### 🐛 Bug Fixes
+
+- Fix order of API docs (#447)
+
+### 📚 Documentation
+
+- Update category slug (#442)
+
+### 🌀 Miscellaneous
+
+- Fastembed integration new parameters (#446)
+
+## [integrations/fastembed-v0.0.4] - 2024-02-16
+
+### 🌀 Miscellaneous
+
+- Fastembed integration: add example (#401)
+- Fastembed fix: add parallel (#403)
+
+## [integrations/fastembed-v0.0.3] - 2024-02-12
+
+### 🐛 Bug Fixes
+
+- From numpy float to float (#391)
+
+### 📚 Documentation
+
+- Update paths and titles (#397)
+
+## [integrations/fastembed-v0.0.2] - 2024-02-11
+
+### 🌀 Miscellaneous
+
+- Updated labeler and readme (#389)
+- Fastembed fix: added prefix and suffix (#390)
+
+## [integrations/fastembed-v0.0.1] - 2024-02-10
+
+### 🌀 Miscellaneous
+
+- Add Fastembed Embeddings integration (#383)
+
+<!-- generated by git-cliff -->

{fastembed_haystack-1.4.0 → fastembed_haystack-1.5.0}/PKG-INFO

@@ -1,23 +1,24 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: fastembed-haystack
-Version: 1.4.0
+Version: 1.5.0
 Summary: Haystack 2.x component to embed strings and Documents using fastembed embedding model
 Project-URL: Source, https://github.com/deepset-ai/haystack-core-integrations
 Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/fastembed/README.md
 Project-URL: Issues, https://github.com/deepset-ai/haystack-core-integrations/issues
 Author-email: deepset GmbH <info@deepset.ai>
-License: Apache-2.0
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
 Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Requires-Dist: fastembed>=0.4.2
 Requires-Dist: haystack-ai>=2.0.1
 Description-Content-Type: text/markdown
@@ -32,6 +33,7 @@ Description-Content-Type: text/markdown
 **Table of Contents**
 
 - [Installation](#installation)
+- [Usage](#Usage)
 - [License](#license)
 
 ## Installation
@@ -57,7 +59,7 @@ embedding = text_embedder.run(text)["embedding"]
 
 ```python
 from haystack_integrations.components.embedders.fastembed import FastembedDocumentEmbedder
-from haystack.dataclasses import Document
+from haystack import Document
 
 embedder = FastembedDocumentEmbedder(
     model="BAAI/bge-small-en-v1.5",
@@ -74,24 +76,50 @@ from haystack_integrations.components.embedders.fastembed import FastembedSparse
 
 text = "fastembed is supported by and maintained by Qdrant."
 text_embedder = FastembedSparseTextEmbedder(
-    model="prithvida/Splade_PP_en_v1"
+    model="prithivida/Splade_PP_en_v1"
 )
 text_embedder.warm_up()
-embedding = text_embedder.run(text)["embedding"]
+embedding = text_embedder.run(text)["sparse_embedding"]
 ```
 
 ```python
 from haystack_integrations.components.embedders.fastembed import FastembedSparseDocumentEmbedder
-from haystack.dataclasses import Document
+from haystack import Document
 
 embedder = FastembedSparseDocumentEmbedder(
-    model="prithvida/Splade_PP_en_v1",
+    model="prithivida/Splade_PP_en_v1",
 )
 embedder.warm_up()
 doc = Document(content="fastembed is supported by and maintained by Qdrant.", meta={"long_answer": "no",})
 result = embedder.run(documents=[doc])
 ```
 
+You can use `FastembedRanker` by importing as:
+
+```python
+from haystack import Document
+
+from haystack_integrations.components.rankers.fastembed import FastembedRanker
+
+query = "Who is maintaining Qdrant?"
+documents = [
+    Document(
+        content="This is built to be faster and lighter than other embedding libraries e.g. Transformers, Sentence-Transformers, etc."
+    ),
+    Document(content="fastembed is supported by and maintained by Qdrant."),
+]
+
+ranker = FastembedRanker(model_name="Xenova/ms-marco-MiniLM-L-6-v2")
+ranker.warm_up()
+reranked_documents = ranker.run(query=query, documents=documents)["documents"]
+
+print(reranked_documents[0])
+
+# Document(id=...,
+#  content: 'fastembed is supported by and maintained by Qdrant.',
+#  score: 5.472434997558594..)
+```
+
 ## License
 
 `fastembed-haystack` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.

{fastembed_haystack-1.4.0 → fastembed_haystack-1.5.0}/README.md

@@ -8,6 +8,7 @@
 **Table of Contents**
 
 - [Installation](#installation)
+- [Usage](#Usage)
 - [License](#license)
 
 ## Installation
@@ -33,7 +34,7 @@ embedding = text_embedder.run(text)["embedding"]
 
 ```python
 from haystack_integrations.components.embedders.fastembed import FastembedDocumentEmbedder
-from haystack.dataclasses import Document
+from haystack import Document
 
 embedder = FastembedDocumentEmbedder(
     model="BAAI/bge-small-en-v1.5",
@@ -50,24 +51,50 @@ from haystack_integrations.components.embedders.fastembed import FastembedSparse
 
 text = "fastembed is supported by and maintained by Qdrant."
 text_embedder = FastembedSparseTextEmbedder(
-    model="prithvida/Splade_PP_en_v1"
+    model="prithivida/Splade_PP_en_v1"
 )
 text_embedder.warm_up()
-embedding = text_embedder.run(text)["embedding"]
+embedding = text_embedder.run(text)["sparse_embedding"]
 ```
 
 ```python
 from haystack_integrations.components.embedders.fastembed import FastembedSparseDocumentEmbedder
-from haystack.dataclasses import Document
+from haystack import Document
 
 embedder = FastembedSparseDocumentEmbedder(
-    model="prithvida/Splade_PP_en_v1",
+    model="prithivida/Splade_PP_en_v1",
 )
 embedder.warm_up()
 doc = Document(content="fastembed is supported by and maintained by Qdrant.", meta={"long_answer": "no",})
 result = embedder.run(documents=[doc])
 ```
 
+You can use `FastembedRanker` by importing as:
+
+```python
+from haystack import Document
+
+from haystack_integrations.components.rankers.fastembed import FastembedRanker
+
+query = "Who is maintaining Qdrant?"
+documents = [
+    Document(
+        content="This is built to be faster and lighter than other embedding libraries e.g. Transformers, Sentence-Transformers, etc."
+    ),
+    Document(content="fastembed is supported by and maintained by Qdrant."),
+]
+
+ranker = FastembedRanker(model_name="Xenova/ms-marco-MiniLM-L-6-v2")
+ranker.warm_up()
+reranked_documents = ranker.run(query=query, documents=documents)["documents"]
+
+print(reranked_documents[0])
+
+# Document(id=...,
+#  content: 'fastembed is supported by and maintained by Qdrant.',
+#  score: 5.472434997558594..)
+```
+
 ## License
 
 `fastembed-haystack` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.

{fastembed_haystack-1.4.0 → fastembed_haystack-1.5.0}/examples/ranker_example.py

@@ -15,7 +15,7 @@ ranker.warm_up()
 reranked_documents = ranker.run(query=query, documents=documents)["documents"]
 
 
-print(reranked_documents["documents"][0])
+print(reranked_documents[0])
 
 # Document(id=...,
 #  content: 'fastembed is supported by and maintained by Qdrant.',

{fastembed_haystack-1.4.0 → fastembed_haystack-1.5.0}/pyproject.toml

@@ -7,7 +7,7 @@ name = "fastembed-haystack"
 dynamic = ["version"]
 description = "Haystack 2.x component to embed strings and Documents using fastembed embedding model"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 license = "Apache-2.0"
 keywords = []
 authors = [{ name = "deepset GmbH", email = "info@deepset.ai" }]
@@ -15,11 +15,11 @@ classifiers = [
   "License :: OSI Approved :: Apache Software License",
   "Development Status :: 4 - Beta",
   "Programming Language :: Python",
-  "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
@@ -43,34 +43,36 @@ git_describe_command = 'git describe --tags --match="integrations/fastembed-v[0-
 
 [tool.hatch.envs.default]
 installer = "uv"
-dependencies = [
-  "coverage[toml]>=6.5",
-  "pytest",
-  "pytest-rerunfailures",
-  "ipython",
-  "haystack-pydoc-tools",
-]
+dependencies = ["haystack-pydoc-tools", "ruff"]
 [tool.hatch.envs.default.scripts]
-test = "pytest {args:tests}"
-test-cov = "coverage run -m pytest {args:tests}"
-test-cov-retry = "test-cov --reruns 3 --reruns-delay 30 -x"
-cov-report = ["- coverage combine", "coverage report"]
-cov = ["test-cov", "cov-report"]
-cov-retry = ["test-cov-retry", "cov-report"]
 docs = ["pydoc-markdown pydoc/config.yml"]
+fmt = "ruff check --fix {args} && ruff format {args}"
+fmt-check = "ruff check {args} && ruff format --check {args}"
+
+[tool.hatch.envs.test]
+dependencies = [
+    "pytest",
+    "pytest-asyncio",
+    "pytest-cov",
+    "pytest-rerunfailures",
+    "mypy",
+    "pip",
+    "ipython"
+]
 
-[[tool.hatch.envs.all.matrix]]
-python = ["3.8", "3.9", "3.10", "3.11", "3.12"]
+[tool.hatch.envs.test.scripts]
+unit = 'pytest -m "not integration" {args:tests}'
+integration = 'pytest -m "integration" {args:tests}'
+all = 'pytest {args:tests}'
+cov-retry = 'all --cov=haystack_integrations --reruns 3 --reruns-delay 30 -x'
+types = """mypy -p haystack_integrations.components.embedders.fastembed \
+-p haystack_integrations.components.rankers.fastembed {args}"""
 
-[tool.hatch.envs.lint]
-installer = "uv"
-detached = true
-dependencies = ["pip", "black>=23.1.0", "mypy>=1.0.0", "ruff>=0.0.243", "numpy"]
-[tool.hatch.envs.lint.scripts]
-typing = "mypy --install-types --non-interactive --explicit-package-bases {args:src/ tests}"
-style = ["ruff check {args:.}", "black --check --diff {args:.}"]
-fmt = ["black {args:.}", "ruff check --fix {args:.}", "style"]
-all = ["style", "typing"]
+[tool.mypy]
+install_types = true
+non_interactive = true
+check_untyped_defs = true
+disallow_incomplete_defs = true
 
 [tool.black]
 target-version = ["py38"]
@@ -156,14 +158,5 @@ exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"]
 
 [tool.pytest.ini_options]
 minversion = "6.0"
-markers = ["unit: unit tests", "integration: integration tests"]
-
-[[tool.mypy.overrides]]
-module = [
-  "haystack.*",
-  "haystack_integrations.*",
-  "fastembed.*",
-  "pytest.*",
-  "numpy.*",
-]
-ignore_missing_imports = true
+markers = ["integration: integration tests"]
+

{fastembed_haystack-1.4.0 → fastembed_haystack-1.5.0}/src/haystack_integrations/components/embedders/fastembed/embedding_backend/fastembed_backend.py

@@ -20,7 +20,7 @@ class _FastembedEmbeddingBackendFactory:
         cache_dir: Optional[str] = None,
         threads: Optional[int] = None,
         local_files_only: bool = False,
-    ):
+    ) -> "_FastembedEmbeddingBackend":
         embedding_backend_id = f"{model_name}{cache_dir}{threads}"
 
         if embedding_backend_id in _FastembedEmbeddingBackendFactory._instances:
@@ -49,7 +49,7 @@ class _FastembedEmbeddingBackend:
             model_name=model_name, cache_dir=cache_dir, threads=threads, local_files_only=local_files_only
         )
 
-    def embed(self, data: List[str], progress_bar=True, **kwargs) -> List[List[float]]:
+    def embed(self, data: List[str], progress_bar: bool = True, **kwargs: Any) -> List[List[float]]:
         # the embed method returns a Iterable[np.ndarray], so we convert it to a list of lists
         embeddings = []
         embeddings_iterable = self.model.embed(data, **kwargs)
@@ -74,7 +74,7 @@ class _FastembedSparseEmbeddingBackendFactory:
         threads: Optional[int] = None,
         local_files_only: bool = False,
         model_kwargs: Optional[Dict[str, Any]] = None,
-    ):
+    ) -> "_FastembedSparseEmbeddingBackend":
         embedding_backend_id = f"{model_name}{cache_dir}{threads}{local_files_only}{model_kwargs}"
 
         if embedding_backend_id in _FastembedSparseEmbeddingBackendFactory._instances:
@@ -114,7 +114,7 @@ class _FastembedSparseEmbeddingBackend:
             **model_kwargs,
         )
 
-    def embed(self, data: List[List[str]], progress_bar=True, **kwargs) -> List[SparseEmbedding]:
+    def embed(self, data: List[str], progress_bar: bool = True, **kwargs: Any) -> List[SparseEmbedding]:
         # The embed method returns a Iterable[SparseEmbedding], so we convert to Haystack SparseEmbedding type.
         # Each SparseEmbedding contains an `indices` key containing a list of int and
         # an `values` key containing a list of floats.

{fastembed_haystack-1.4.0 → fastembed_haystack-1.5.0}/src/haystack_integrations/components/embedders/fastembed/fastembed_document_embedder.py

@@ -150,7 +150,7 @@ class FastembedDocumentEmbedder:
         return texts_to_embed
 
     @component.output_types(documents=List[Document])
-    def run(self, documents: List[Document]):
+    def run(self, documents: List[Document]) -> Dict[str, List[Document]]:
         """
         Embeds a list of Documents.
 
@@ -158,7 +158,7 @@ class FastembedDocumentEmbedder:
         :returns: A dictionary with the following keys:
             - `documents`: List of Documents with each Document's `embedding` field set to the computed embeddings.
         """
-        if not isinstance(documents, list) or documents and not isinstance(documents[0], Document):
+        if not isinstance(documents, list) or (documents and not isinstance(documents[0], Document)):
             msg = (
                 "FastembedDocumentEmbedder expects a list of Documents as input. "
                 "In case you want to embed a list of strings, please use the FastembedTextEmbedder."

{fastembed_haystack-1.4.0 → fastembed_haystack-1.5.0}/src/haystack_integrations/components/embedders/fastembed/fastembed_sparse_document_embedder.py

@@ -16,7 +16,7 @@ class FastembedSparseDocumentEmbedder:
     from haystack.dataclasses import Document
 
     sparse_doc_embedder = FastembedSparseDocumentEmbedder(
-        model="prithvida/Splade_PP_en_v1",
+        model="prithivida/Splade_PP_en_v1",
         batch_size=32,
     )
 
@@ -53,7 +53,7 @@ class FastembedSparseDocumentEmbedder:
 
     def __init__(
         self,
-        model: str = "prithvida/Splade_PP_en_v1",
+        model: str = "prithivida/Splade_PP_en_v1",
         cache_dir: Optional[str] = None,
         threads: Optional[int] = None,
         batch_size: int = 32,
@@ -68,7 +68,7 @@ class FastembedSparseDocumentEmbedder:
         Create an FastembedDocumentEmbedder component.
 
         :param model: Local path or name of the model in Hugging Face's model hub,
-            such as `prithvida/Splade_PP_en_v1`.
+            such as `prithivida/Splade_PP_en_v1`.
         :param cache_dir: The path to the cache directory.
                 Can be set using the `FASTEMBED_CACHE_PATH` env variable.
                 Defaults to `fastembed_cache` in the system's temp directory.
@@ -141,7 +141,7 @@ class FastembedSparseDocumentEmbedder:
         return texts_to_embed
 
     @component.output_types(documents=List[Document])
-    def run(self, documents: List[Document]):
+    def run(self, documents: List[Document]) -> Dict[str, List[Document]]:
         """
         Embeds a list of Documents.
 
@@ -150,7 +150,7 @@ class FastembedSparseDocumentEmbedder:
             - `documents`: List of Documents with each Document's `sparse_embedding`
                             field set to the computed embeddings.
         """
-        if not isinstance(documents, list) or documents and not isinstance(documents[0], Document):
+        if not isinstance(documents, list) or (documents and not isinstance(documents[0], Document)):
             msg = (
                 "FastembedSparseDocumentEmbedder expects a list of Documents as input. "
                 "In case you want to embed a list of strings, please use the FastembedTextEmbedder."

{fastembed_haystack-1.4.0 → fastembed_haystack-1.5.0}/src/haystack_integrations/components/embedders/fastembed/fastembed_sparse_text_embedder.py

@@ -19,7 +19,7 @@ class FastembedSparseTextEmbedder:
             "The disk comes and it does not, only Windows. Do Not order this if you have a Mac!!")
 
     sparse_text_embedder = FastembedSparseTextEmbedder(
-        model="prithvida/Splade_PP_en_v1"
+        model="prithivida/Splade_PP_en_v1"
     )
     sparse_text_embedder.warm_up()
 
@@ -29,7 +29,7 @@ class FastembedSparseTextEmbedder:
 
     def __init__(
         self,
-        model: str = "prithvida/Splade_PP_en_v1",
+        model: str = "prithivida/Splade_PP_en_v1",
         cache_dir: Optional[str] = None,
         threads: Optional[int] = None,
         progress_bar: bool = True,
@@ -40,7 +40,7 @@ class FastembedSparseTextEmbedder:
         """
         Create a FastembedSparseTextEmbedder component.
 
-        :param model: Local path or name of the model in Fastembed's model hub, such as `prithvida/Splade_PP_en_v1`
+        :param model: Local path or name of the model in Fastembed's model hub, such as `prithivida/Splade_PP_en_v1`
         :param cache_dir: The path to the cache directory.
                 Can be set using the `FASTEMBED_CACHE_PATH` env variable.
                 Defaults to `fastembed_cache` in the system's temp directory.
@@ -94,7 +94,7 @@ class FastembedSparseTextEmbedder:
             )
 
     @component.output_types(sparse_embedding=SparseEmbedding)
-    def run(self, text: str):
+    def run(self, text: str) -> Dict[str, SparseEmbedding]:
         """
         Embeds text using the Fastembed model.
 

{fastembed_haystack-1.4.0 → fastembed_haystack-1.5.0}/src/haystack_integrations/components/embedders/fastembed/fastembed_text_embedder.py

@@ -96,7 +96,7 @@ class FastembedTextEmbedder:
             )
 
     @component.output_types(embedding=List[float])
-    def run(self, text: str):
+    def run(self, text: str) -> Dict[str, List[float]]:
         """
         Embeds text using the Fastembed model.
 

{fastembed_haystack-1.4.0 → fastembed_haystack-1.5.0}/src/haystack_integrations/components/rankers/fastembed/ranker.py

@@ -76,7 +76,7 @@ class FastembedRanker:
         self.local_files_only = local_files_only
         self.meta_fields_to_embed = meta_fields_to_embed or []
         self.meta_data_separator = meta_data_separator
-        self._model = None
+        self._model: Optional[TextCrossEncoder] = None
 
     def to_dict(self) -> Dict[str, Any]:
         """
@@ -140,7 +140,7 @@ class FastembedRanker:
         return concatenated_input_list
 
     @component.output_types(documents=List[Document])
-    def run(self, query: str, documents: List[Document], top_k: Optional[int] = None):
+    def run(self, query: str, documents: List[Document], top_k: Optional[int] = None) -> Dict[str, List[Document]]:
         """
         Returns a list of documents ranked by their similarity to the given query, using FastEmbed.
 
@@ -157,7 +157,7 @@ class FastembedRanker:
 
         :raises ValueError: If `top_k` is not > 0.
         """
-        if not isinstance(documents, list) or documents and not isinstance(documents[0], Document):
+        if not isinstance(documents, list) or (documents and not isinstance(documents[0], Document)):
             msg = "FastembedRanker expects a list of Documents as input. "
             raise TypeError(msg)
         if query == "":

{fastembed_haystack-1.4.0 → fastembed_haystack-1.5.0}/tests/test_fastembed_sparse_document_embedder.py

@@ -15,8 +15,8 @@ class TestFastembedSparseDocumentEmbedderDoc:
         """
         Test default initialization parameters for FastembedSparseDocumentEmbedder.
         """
-        embedder = FastembedSparseDocumentEmbedder(model="prithvida/Splade_PP_en_v1")
-        assert embedder.model_name == "prithvida/Splade_PP_en_v1"
+        embedder = FastembedSparseDocumentEmbedder(model="prithivida/Splade_PP_en_v1")
+        assert embedder.model_name == "prithivida/Splade_PP_en_v1"
         assert embedder.cache_dir is None
         assert embedder.threads is None
         assert embedder.batch_size == 32
@@ -31,7 +31,7 @@ class TestFastembedSparseDocumentEmbedderDoc:
         Test custom initialization parameters for FastembedSparseDocumentEmbedder.
         """
         embedder = FastembedSparseDocumentEmbedder(
-            model="prithvida/Splade_PP_en_v1",
+            model="prithivida/Splade_PP_en_v1",
             cache_dir="fake_dir",
             threads=2,
             batch_size=64,
@@ -41,7 +41,7 @@ class TestFastembedSparseDocumentEmbedderDoc:
             meta_fields_to_embed=["test_field"],
             embedding_separator=" | ",
         )
-        assert embedder.model_name == "prithvida/Splade_PP_en_v1"
+        assert embedder.model_name == "prithivida/Splade_PP_en_v1"
         assert embedder.cache_dir == "fake_dir"
         assert embedder.threads == 2
         assert embedder.batch_size == 64
@@ -55,12 +55,12 @@ class TestFastembedSparseDocumentEmbedderDoc:
         """
         Test serialization of FastembedSparseDocumentEmbedder to a dictionary, using default initialization parameters.
         """
-        embedder = FastembedSparseDocumentEmbedder(model="prithvida/Splade_PP_en_v1")
+        embedder = FastembedSparseDocumentEmbedder(model="prithivida/Splade_PP_en_v1")
         embedder_dict = embedder.to_dict()
         assert embedder_dict == {
             "type": "haystack_integrations.components.embedders.fastembed.fastembed_sparse_document_embedder.FastembedSparseDocumentEmbedder",  #  noqa
             "init_parameters": {
-                "model": "prithvida/Splade_PP_en_v1",
+                "model": "prithivida/Splade_PP_en_v1",
                 "cache_dir": None,
                 "threads": None,
                 "batch_size": 32,
@@ -78,7 +78,7 @@ class TestFastembedSparseDocumentEmbedderDoc:
         Test serialization of FastembedSparseDocumentEmbedder to a dictionary, using custom initialization parameters.
         """
         embedder = FastembedSparseDocumentEmbedder(
-            model="prithvida/Splade_PP_en_v1",
+            model="prithivida/Splade_PP_en_v1",
             cache_dir="fake_dir",
             threads=2,
             batch_size=64,
@@ -92,7 +92,7 @@ class TestFastembedSparseDocumentEmbedderDoc:
         assert embedder_dict == {
             "type": "haystack_integrations.components.embedders.fastembed.fastembed_sparse_document_embedder.FastembedSparseDocumentEmbedder",  #  noqa
             "init_parameters": {
-                "model": "prithvida/Splade_PP_en_v1",
+                "model": "prithivida/Splade_PP_en_v1",
                 "cache_dir": "fake_dir",
                 "threads": 2,
                 "batch_size": 64,
@@ -113,7 +113,7 @@ class TestFastembedSparseDocumentEmbedderDoc:
         embedder_dict = {
             "type": "haystack_integrations.components.embedders.fastembed.fastembed_sparse_document_embedder.FastembedSparseDocumentEmbedder",  #  noqa
             "init_parameters": {
-                "model": "prithvida/Splade_PP_en_v1",
+                "model": "prithivida/Splade_PP_en_v1",
                 "cache_dir": None,
                 "threads": None,
                 "batch_size": 32,
@@ -125,7 +125,7 @@ class TestFastembedSparseDocumentEmbedderDoc:
             },
         }
         embedder = default_from_dict(FastembedSparseDocumentEmbedder, embedder_dict)
-        assert embedder.model_name == "prithvida/Splade_PP_en_v1"
+        assert embedder.model_name == "prithivida/Splade_PP_en_v1"
         assert embedder.cache_dir is None
         assert embedder.threads is None
         assert embedder.batch_size == 32
@@ -143,7 +143,7 @@ class TestFastembedSparseDocumentEmbedderDoc:
         embedder_dict = {
             "type": "haystack_integrations.components.embedders.fastembed.fastembed_sparse_document_embedder.FastembedSparseDocumentEmbedder",  #  noqa
             "init_parameters": {
-                "model": "prithvida/Splade_PP_en_v1",
+                "model": "prithivida/Splade_PP_en_v1",
                 "cache_dir": "fake_dir",
                 "threads": 2,
                 "batch_size": 64,
@@ -155,7 +155,7 @@ class TestFastembedSparseDocumentEmbedderDoc:
             },
         }
         embedder = default_from_dict(FastembedSparseDocumentEmbedder, embedder_dict)
-        assert embedder.model_name == "prithvida/Splade_PP_en_v1"
+        assert embedder.model_name == "prithivida/Splade_PP_en_v1"
         assert embedder.cache_dir == "fake_dir"
         assert embedder.threads == 2
         assert embedder.batch_size == 64
@@ -172,11 +172,11 @@ class TestFastembedSparseDocumentEmbedderDoc:
         """
         Test for checking embedder instances after warm-up.
         """
-        embedder = FastembedSparseDocumentEmbedder(model="prithvida/Splade_PP_en_v1")
+        embedder = FastembedSparseDocumentEmbedder(model="prithivida/Splade_PP_en_v1")
         mocked_factory.get_embedding_backend.assert_not_called()
         embedder.warm_up()
         mocked_factory.get_embedding_backend.assert_called_once_with(
-            model_name="prithvida/Splade_PP_en_v1",
+            model_name="prithivida/Splade_PP_en_v1",
             cache_dir=None,
             threads=None,
             local_files_only=False,
@@ -190,7 +190,7 @@ class TestFastembedSparseDocumentEmbedderDoc:
         """
         Test for checking backend instances after multiple warm-ups.
         """
-        embedder = FastembedSparseDocumentEmbedder(model="prithvida/Splade_PP_en_v1")
+        embedder = FastembedSparseDocumentEmbedder(model="prithivida/Splade_PP_en_v1")
         mocked_factory.get_embedding_backend.assert_not_called()
         embedder.warm_up()
         embedder.warm_up()
@@ -211,7 +211,7 @@ class TestFastembedSparseDocumentEmbedderDoc:
         """
         Test for checking output dimensions and embedding dimensions.
         """
-        embedder = FastembedSparseDocumentEmbedder(model="prithvida/Splade_PP_en_v1")
+        embedder = FastembedSparseDocumentEmbedder(model="prithivida/Splade_PP_en_v1")
         embedder.embedding_backend = MagicMock()
         embedder.embedding_backend.embed = lambda x, **kwargs: self._generate_mocked_sparse_embedding(  # noqa: ARG005
             len(x)
@@ -235,7 +235,7 @@ class TestFastembedSparseDocumentEmbedderDoc:
         """
         Test for checking incorrect input format when creating embedding.
         """
-        embedder = FastembedSparseDocumentEmbedder(model="prithvida/Splade_PP_en_v1")
+        embedder = FastembedSparseDocumentEmbedder(model="prithivida/Splade_PP_en_v1")
 
         string_input = "text"
         list_integers_input = [1, 2, 3]
@@ -330,7 +330,7 @@ class TestFastembedSparseDocumentEmbedderDoc:
     @pytest.mark.integration
     def test_run(self):
         embedder = FastembedSparseDocumentEmbedder(
-            model="prithvida/Splade_PP_en_v1",
+            model="prithivida/Splade_PP_en_v1",
         )
         embedder.warm_up()
 

{fastembed_haystack-1.4.0 → fastembed_haystack-1.5.0}/tests/test_fastembed_sparse_text_embedder.py

@@ -15,8 +15,8 @@ class TestFastembedSparseTextEmbedder:
         """
         Test default initialization parameters for FastembedSparseTextEmbedder.
         """
-        embedder = FastembedSparseTextEmbedder(model="prithvida/Splade_PP_en_v1")
-        assert embedder.model_name == "prithvida/Splade_PP_en_v1"
+        embedder = FastembedSparseTextEmbedder(model="prithivida/Splade_PP_en_v1")
+        assert embedder.model_name == "prithivida/Splade_PP_en_v1"
         assert embedder.cache_dir is None
         assert embedder.threads is None
         assert embedder.progress_bar is True
@@ -27,13 +27,13 @@ class TestFastembedSparseTextEmbedder:
         Test custom initialization parameters for FastembedSparseTextEmbedder.
         """
         embedder = FastembedSparseTextEmbedder(
-            model="prithvida/Splade_PP_en_v1",
+            model="prithivida/Splade_PP_en_v1",
             cache_dir="fake_dir",
             threads=2,
             progress_bar=False,
             parallel=1,
         )
-        assert embedder.model_name == "prithvida/Splade_PP_en_v1"
+        assert embedder.model_name == "prithivida/Splade_PP_en_v1"
         assert embedder.cache_dir == "fake_dir"
         assert embedder.threads == 2
         assert embedder.progress_bar is False
@@ -43,12 +43,12 @@ class TestFastembedSparseTextEmbedder:
         """
         Test serialization of FastembedSparseTextEmbedder to a dictionary, using default initialization parameters.
         """
-        embedder = FastembedSparseTextEmbedder(model="prithvida/Splade_PP_en_v1")
+        embedder = FastembedSparseTextEmbedder(model="prithivida/Splade_PP_en_v1")
         embedder_dict = embedder.to_dict()
         assert embedder_dict == {
             "type": "haystack_integrations.components.embedders.fastembed.fastembed_sparse_text_embedder.FastembedSparseTextEmbedder",  # noqa
             "init_parameters": {
-                "model": "prithvida/Splade_PP_en_v1",
+                "model": "prithivida/Splade_PP_en_v1",
                 "cache_dir": None,
                 "threads": None,
                 "progress_bar": True,
@@ -63,7 +63,7 @@ class TestFastembedSparseTextEmbedder:
         Test serialization of FastembedSparseTextEmbedder to a dictionary, using custom initialization parameters.
         """
         embedder = FastembedSparseTextEmbedder(
-            model="prithvida/Splade_PP_en_v1",
+            model="prithivida/Splade_PP_en_v1",
             cache_dir="fake_dir",
             threads=2,
             progress_bar=False,
@@ -74,7 +74,7 @@ class TestFastembedSparseTextEmbedder:
         assert embedder_dict == {
             "type": "haystack_integrations.components.embedders.fastembed.fastembed_sparse_text_embedder.FastembedSparseTextEmbedder",  # noqa
             "init_parameters": {
-                "model": "prithvida/Splade_PP_en_v1",
+                "model": "prithivida/Splade_PP_en_v1",
                 "cache_dir": "fake_dir",
                 "threads": 2,
                 "progress_bar": False,
@@ -91,7 +91,7 @@ class TestFastembedSparseTextEmbedder:
         embedder_dict = {
             "type": "haystack_integrations.components.embedders.fastembed.fastembed_sparse_text_embedder.FastembedSparseTextEmbedder",  # noqa
             "init_parameters": {
-                "model": "prithvida/Splade_PP_en_v1",
+                "model": "prithivida/Splade_PP_en_v1",
                 "cache_dir": None,
                 "threads": None,
                 "progress_bar": True,
@@ -99,7 +99,7 @@ class TestFastembedSparseTextEmbedder:
             },
         }
         embedder = default_from_dict(FastembedSparseTextEmbedder, embedder_dict)
-        assert embedder.model_name == "prithvida/Splade_PP_en_v1"
+        assert embedder.model_name == "prithivida/Splade_PP_en_v1"
         assert embedder.cache_dir is None
         assert embedder.threads is None
         assert embedder.progress_bar is True
@@ -112,7 +112,7 @@ class TestFastembedSparseTextEmbedder:
         embedder_dict = {
             "type": "haystack_integrations.components.embedders.fastembed.fastembed_sparse_text_embedder.FastembedSparseTextEmbedder",  # noqa
             "init_parameters": {
-                "model": "prithvida/Splade_PP_en_v1",
+                "model": "prithivida/Splade_PP_en_v1",
                 "cache_dir": "fake_dir",
                 "threads": 2,
                 "progress_bar": False,
@@ -120,7 +120,7 @@ class TestFastembedSparseTextEmbedder:
             },
         }
         embedder = default_from_dict(FastembedSparseTextEmbedder, embedder_dict)
-        assert embedder.model_name == "prithvida/Splade_PP_en_v1"
+        assert embedder.model_name == "prithivida/Splade_PP_en_v1"
         assert embedder.cache_dir == "fake_dir"
         assert embedder.threads == 2
         assert embedder.progress_bar is False
@@ -133,11 +133,11 @@ class TestFastembedSparseTextEmbedder:
         """
         Test for checking embedder instances after warm-up.
         """
-        embedder = FastembedSparseTextEmbedder(model="prithvida/Splade_PP_en_v1")
+        embedder = FastembedSparseTextEmbedder(model="prithivida/Splade_PP_en_v1")
         mocked_factory.get_embedding_backend.assert_not_called()
         embedder.warm_up()
         mocked_factory.get_embedding_backend.assert_called_once_with(
-            model_name="prithvida/Splade_PP_en_v1",
+            model_name="prithivida/Splade_PP_en_v1",
             cache_dir=None,
             threads=None,
             local_files_only=False,
@@ -151,7 +151,7 @@ class TestFastembedSparseTextEmbedder:
         """
         Test for checking backend instances after multiple warm-ups.
         """
-        embedder = FastembedSparseTextEmbedder(model="prithvida/Splade_PP_en_v1")
+        embedder = FastembedSparseTextEmbedder(model="prithivida/Splade_PP_en_v1")
         mocked_factory.get_embedding_backend.assert_not_called()
         embedder.warm_up()
         embedder.warm_up()
@@ -252,7 +252,7 @@ class TestFastembedSparseTextEmbedder:
     @pytest.mark.integration
     def test_run(self):
         embedder = FastembedSparseTextEmbedder(
-            model="prithvida/Splade_PP_en_v1",
+            model="prithivida/Splade_PP_en_v1",
         )
         embedder.warm_up()
 

fastembed_haystack-1.4.0/CHANGELOG.md

@@ -1,72 +0,0 @@
-# Changelog
-
-## [integrations/fastembed-v1.3.0] - 2024-10-07
-
-### 🚀 Features
-
-- Introduce `model_kwargs` in Sparse Embedders (can be used for BM25 parameters) (#1126)
-
-### 🧪 Testing
-
-- Do not retry tests in `hatch run test` command (#954)
-
-### ⚙️ Miscellaneous Tasks
-
-- Retry tests to reduce flakyness (#836)
-- Update ruff invocation to include check parameter (#853)
-- Update ruff linting scripts and settings (#1105)
-
-### Fix
-
-- Typo on Sparse embedders. The parameter should be "progress_bar" … (#814)
-
-## [integrations/fastembed-v1.1.0] - 2024-05-15
-
-## [integrations/fastembed-v1.0.0] - 2024-05-06
-
-## [integrations/fastembed-v0.1.0] - 2024-04-10
-
-### 🚀 Features
-
-- *(FastEmbed)* Support for SPLADE Sparse Embedder (#579)
-
-### 📚 Documentation
-
-- Disable-class-def (#556)
-
-## [integrations/fastembed-v0.0.6] - 2024-03-07
-
-### 📚 Documentation
-
-- Review and normalize docstrings - `integrations.fastembed` (#519)
-- Small consistency improvements (#536)
-
-## [integrations/fastembed-v0.0.5] - 2024-02-20
-
-### 🐛 Bug Fixes
-
-- Fix order of API docs (#447)
-
-This PR will also push the docs to Readme
-
-### 📚 Documentation
-
-- Update category slug (#442)
-
-## [integrations/fastembed-v0.0.4] - 2024-02-16
-
-## [integrations/fastembed-v0.0.3] - 2024-02-12
-
-### 🐛 Bug Fixes
-
-- From numpy float to float (#391)
-
-### 📚 Documentation
-
-- Update paths and titles (#397)
-
-## [integrations/fastembed-v0.0.2] - 2024-02-11
-
-## [integrations/fastembed-v0.0.1] - 2024-02-10
-
-<!-- generated by git-cliff -->

{fastembed_haystack-1.4.0 → fastembed_haystack-1.5.0}/src/haystack_integrations/components/embedders/fastembed/__init__.py

@@ -8,7 +8,7 @@ from .fastembed_text_embedder import FastembedTextEmbedder
 
 __all__ = [
     "FastembedDocumentEmbedder",
-    "FastembedTextEmbedder",
     "FastembedSparseDocumentEmbedder",
     "FastembedSparseTextEmbedder",
+    "FastembedTextEmbedder",
 ]