meilisearch-python-sdk 4.1.1__py3-none-any.whl → 4.2.0__py3-none-any.whl

meilisearch_python_sdk/_client.py

@@ -623,15 +623,18 @@ class AsyncClient(BaseClient):
             >>>     search_results = await client.search(queries)
         """
         url = "multi-search"
-        if federation:
-            processed_queries = []
-            for query in queries:
-                q = query.model_dump(by_alias=True)
+        processed_queries = []
+        for query in queries:
+            q = query.model_dump(by_alias=True)
+
+            if query.retrieve_vectors is None:
+                del q["retrieveVectors"]
+
+            if federation:
                 del q["limit"]
                 del q["offset"]
-                processed_queries.append(q)
-        else:
-            processed_queries = [x.model_dump(by_alias=True) for x in queries]
+
+            processed_queries.append(q)
 
         if federation:
             federation_payload = federation.model_dump(by_alias=True)
@@ -1479,15 +1482,18 @@ class Client(BaseClient):
             >>> search_results = client.search(queries)
         """
         url = "multi-search"
-        if federation:
-            processed_queries = []
-            for query in queries:
-                q = query.model_dump(by_alias=True)
+        processed_queries = []
+        for query in queries:
+            q = query.model_dump(by_alias=True)
+
+            if query.retrieve_vectors is None:
+                del q["retrieveVectors"]
+
+            if federation:
                 del q["limit"]
                 del q["offset"]
-                processed_queries.append(q)
-        else:
-            processed_queries = [x.model_dump(by_alias=True) for x in queries]
+
+            processed_queries.append(q)
 
         if federation:
             federation_payload = federation.model_dump(by_alias=True)

meilisearch_python_sdk/_version.py

@@ -1 +1 @@
-VERSION = "4.1.1"
+VERSION = "4.2.0"

meilisearch_python_sdk/index.py

@@ -721,6 +721,7 @@ class AsyncIndex(_BaseIndex):
         vector: list[float] | None = None,
         hybrid: Hybrid | None = None,
         locales: list[str] | None = None,
+        retrieve_vectors: bool | None = None,
     ) -> SearchResults:
         """Search the index.
 
@@ -781,6 +782,7 @@ class AsyncIndex(_BaseIndex):
                 with caution.
             locales: Specifies the languages for the search. This parameter can only be used with
                 Milisearch >= v1.10.0. Defaults to None letting the Meilisearch pick.
+            retrieve_vectors: Return document vector data with search result.
 
         Returns:
             Results of the search
@@ -824,6 +826,7 @@ class AsyncIndex(_BaseIndex):
             hybrid=hybrid,
             ranking_score_threshold=ranking_score_threshold,
             locales=locales,
+            retrieve_vectors=retrieve_vectors,
         )
         search_url = f"{self._base_url_with_uid}/search"
 
@@ -986,6 +989,7 @@ class AsyncIndex(_BaseIndex):
         ranking_score_threshold: float | None = None,
         vector: list[float] | None = None,
         locales: list[str] | None = None,
+        retrieve_vectors: bool | None = None,
     ) -> FacetSearchResults:
         """Search the index.
 
@@ -1038,6 +1042,7 @@ class AsyncIndex(_BaseIndex):
                 with caution.
             locales: Specifies the languages for the search. This parameter can only be used with
                 Milisearch >= v1.10.0. Defaults to None letting the Meilisearch pick.
+            retrieve_vectors: Return document vector data with search result.
 
         Returns:
             Results of the search
@@ -1085,6 +1090,7 @@ class AsyncIndex(_BaseIndex):
             ranking_score_threshold=ranking_score_threshold,
             vector=vector,
             locales=locales,
+            retrieve_vectors=retrieve_vectors,
         )
         search_url = f"{self._base_url_with_uid}/facet-search"
 
@@ -5085,6 +5091,7 @@ class Index(_BaseIndex):
         vector: list[float] | None = None,
         hybrid: Hybrid | None = None,
         locales: list[str] | None = None,
+        retrieve_vectors: bool | None = None,
     ) -> SearchResults:
         """Search the index.
 
@@ -5145,6 +5152,7 @@ class Index(_BaseIndex):
                 with caution.
             locales: Specifies the languages for the search. This parameter can only be used with
                 Milisearch >= v1.10.0. Defaults to None letting the Meilisearch pick.
+            retrieve_vectors: Return document vector data with search result.
 
         Returns:
             Results of the search
@@ -5188,6 +5196,7 @@ class Index(_BaseIndex):
             hybrid=hybrid,
             ranking_score_threshold=ranking_score_threshold,
             locales=locales,
+            retrieve_vectors=retrieve_vectors,
         )
 
         if self._pre_search_plugins:
@@ -5256,6 +5265,7 @@ class Index(_BaseIndex):
         ranking_score_threshold: float | None = None,
         vector: list[float] | None = None,
         locales: list[str] | None = None,
+        retrieve_vectors: bool | None = None,
     ) -> FacetSearchResults:
         """Search the index.
 
@@ -5308,6 +5318,7 @@ class Index(_BaseIndex):
                 with caution.
             locales: Specifies the languages for the search. This parameter can only be used with
                 Milisearch >= v1.10.0. Defaults to None letting the Meilisearch pick.
+            retrieve_vectors: Return document vector data with search result.
 
         Returns:
             Results of the search
@@ -5355,6 +5366,7 @@ class Index(_BaseIndex):
             ranking_score_threshold=ranking_score_threshold,
             vector=vector,
             locales=locales,
+            retrieve_vectors=retrieve_vectors,
         )
 
         if self._pre_facet_search_plugins:
@@ -8262,6 +8274,7 @@ def _process_search_parameters(
     vector: list[float] | None = None,
     hybrid: Hybrid | None = None,
     locales: list[str] | None = None,
+    retrieve_vectors: bool | None = None,
 ) -> JsonDict:
     if attributes_to_retrieve is None:
         attributes_to_retrieve = ["*"]
@@ -8310,6 +8323,9 @@ def _process_search_parameters(
     if locales:
         body["locales"] = locales
 
+    if retrieve_vectors is not None:
+        body["retrieveVectors"] = retrieve_vectors
+
     return body
 
 

meilisearch_python_sdk/models/search.py

@@ -70,6 +70,7 @@ class SearchParams(CamelBase):
     vector: list[float] | None = None
     hybrid: Hybrid | None = None
     locales: list[str] | None = None
+    retrieve_vectors: bool | None = None
 
     @field_validator("ranking_score_threshold", mode="before")  # type: ignore[attr-defined]
     @classmethod

meilisearch_python_sdk/models/settings.py

@@ -56,6 +56,7 @@ class OpenAiEmbedder(CamelBase):
     document_template: str | None = None
     document_template_max_bytes: int | None = None
     distribution: Distribution | None = None
+    binary_quantized: bool | None = None
 
 
 class HuggingFaceEmbedder(CamelBase):
@@ -65,6 +66,8 @@ class HuggingFaceEmbedder(CamelBase):
     document_template: str | None = None
     document_template_max_bytes: int | None = None
     distribution: Distribution | None = None
+    dimensions: int | None = None
+    binary_quantized: bool | None = None
 
 
 class OllamaEmbedder(CamelBase):
@@ -76,6 +79,7 @@ class OllamaEmbedder(CamelBase):
     document_template: str | None = None
     document_template_max_bytes: int | None = None
     distribution: Distribution | None = None
+    binary_quantized: bool | None = None
 
 
 class RestEmbedder(CamelBase):
@@ -89,12 +93,16 @@ class RestEmbedder(CamelBase):
     headers: JsonDict | None = None
     request: JsonDict
     response: JsonDict
+    binary_quantized: bool | None = None
 
 
 class UserProvidedEmbedder(CamelBase):
     source: str = "userProvided"
     dimensions: int
     distribution: Distribution | None = None
+    document_template: str | None = None
+    document_template_max_bytes: int | None = None
+    binary_quantized: bool | None = None
 
 
 class Embedders(CamelBase):

{meilisearch_python_sdk-4.1.1.dist-info → meilisearch_python_sdk-4.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 4.1.1
+Version: 4.2.0
 Summary: A Python client providing both async and sync support for the Meilisearch API
 Project-URL: repository, https://github.com/sanders41/meilisearch-python-sdk
 Project-URL: homepage, https://github.com/sanders41/meilisearch-python-sdk

{meilisearch_python_sdk-4.1.1.dist-info → meilisearch_python_sdk-4.2.0.dist-info}/RECORD

@@ -1,13 +1,13 @@
 meilisearch_python_sdk/__init__.py,sha256=SB0Jlm6FwT13J9xasZKseZzTWBk0hkfe1CWyWmIIZnE,258
 meilisearch_python_sdk/_batch.py,sha256=Hbt-M8Lt8ZDZqcKToUMzUd5zvT-gku709er4pRlvXWk,5065
-meilisearch_python_sdk/_client.py,sha256=LJ_MXxdIMfZ-Rva3feZRS7pzfY7rgr0lYUxY8hD9be4,73282
+meilisearch_python_sdk/_client.py,sha256=6nMAYLiRF0uPC52qL8VnlbrUGEkJ8IkU7zyJvtq961k,73254
 meilisearch_python_sdk/_http_requests.py,sha256=O3M3n-t1jAKwccWowPbk-HPD3ExtHq8a3XhnZT5facs,6746
 meilisearch_python_sdk/_task.py,sha256=QgVcqMlZdURRS_oYpB_bTBa5dvT3Sp_-O0-s6TqAxHk,12485
 meilisearch_python_sdk/_utils.py,sha256=NoCDxJPhjABeuSxFTNCih585UDWdXEUBD_FvdgtScQw,1539
-meilisearch_python_sdk/_version.py,sha256=c4Mq0PB9iieEclDeTA6m_tZX7t3ur0ECMvUGRiBxBr4,18
+meilisearch_python_sdk/_version.py,sha256=tfZYB_qyfEQ96DjLP8yhtGHJf56IeQgsGF98v1EvdJE,18
 meilisearch_python_sdk/decorators.py,sha256=njMn40P-qOzKGGQLCDpsBKWyj2ai10s4XG4IUBSHoD4,8674
 meilisearch_python_sdk/errors.py,sha256=RNNHXtXLBiCVZaLM2MeKKs9RbRuE-SLRttiPeVAEXgA,2133
-meilisearch_python_sdk/index.py,sha256=QIZk0O8cZ3qR2osPb03gSatR72dGaFEF_MC0PqTLmdU,341518
+meilisearch_python_sdk/index.py,sha256=ipJ0L7gZuDYPSnqEz80Ow5lmUQkAHy0W8KMLkNn6Xsw,342333
 meilisearch_python_sdk/json_handler.py,sha256=c1rGKzYlE0dGfLygQjPqVUNfQkN1JvafBGmIx31JW8g,2044
 meilisearch_python_sdk/plugins.py,sha256=YySzTuVr4IrogTgrP8q-gZPsew8TwedopjWnTj5eV48,3607
 meilisearch_python_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -18,11 +18,11 @@ meilisearch_python_sdk/models/client.py,sha256=ntecx3ya_5EwgnxZfqYsBg9UlyQe_i3jg
 meilisearch_python_sdk/models/documents.py,sha256=eT3FHrPND-g2IzNRyOHQApTTJ1WbFcGlqgxZ6aKrRgI,247
 meilisearch_python_sdk/models/health.py,sha256=hvruti7ylsk7bAh8RPOhTPcRrjx6MPgdkDFX9vZ5Qks,95
 meilisearch_python_sdk/models/index.py,sha256=GGwuhx5Wsn5iyj1ov3f4eWjfw6ttM8WzvyrnSsC4vRg,1132
-meilisearch_python_sdk/models/search.py,sha256=lbZXN4DGb3arpG7LtFUxzfOMszIvz24seFRodOaeiVs,3446
-meilisearch_python_sdk/models/settings.py,sha256=uCm-F4PDeCR5e2d8WrGT8hwq0VhrCv19MatQVpS8ocU,4154
+meilisearch_python_sdk/models/search.py,sha256=ZySZyA18QuJavz82gK7Kkqfp0fIxWVervCw24W6bToA,3487
+meilisearch_python_sdk/models/settings.py,sha256=ElFzguRJD2GsAU0sZ5lmqdH-QXPM-HQJr1O_wC1Zbzs,4485
 meilisearch_python_sdk/models/task.py,sha256=_PyuH5tSlHCKMwFsx1nMKjFgc8bDBZxscKYZOdf-4pg,2166
 meilisearch_python_sdk/models/version.py,sha256=YDu-aj5H-d6nSaWRTXzlwWghmZAoiknaw250UyEd48I,215
-meilisearch_python_sdk-4.1.1.dist-info/METADATA,sha256=pyzi4roX2dRKZ_JC7SleT7fK9sNO_HDnNfOh7vhe7DY,9763
-meilisearch_python_sdk-4.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-meilisearch_python_sdk-4.1.1.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
-meilisearch_python_sdk-4.1.1.dist-info/RECORD,,
+meilisearch_python_sdk-4.2.0.dist-info/METADATA,sha256=TsBW-27Y1r0SbB8D-rgLCgfcsePQY6UAs-7pFWNwfPo,9763
+meilisearch_python_sdk-4.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+meilisearch_python_sdk-4.2.0.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
+meilisearch_python_sdk-4.2.0.dist-info/RECORD,,