meilisearch-python-sdk 4.3.0__py3-none-any.whl → 4.4.0__py3-none-any.whl

meilisearch_python_sdk/_version.py

@@ -1 +1 @@
-VERSION = "4.3.0"
+VERSION = "4.4.0"

meilisearch_python_sdk/index.py

@@ -1288,12 +1288,22 @@ class AsyncIndex(_BaseIndex):
 
         return SimilarSearchResults[self.hits_type](**response.json())  # type: ignore[name-defined]
 
-    async def get_document(self, document_id: str) -> JsonDict:
+    async def get_document(
+        self,
+        document_id: str,
+        *,
+        fields: list[str] | None = None,
+        retrieve_vectors: bool = False,
+    ) -> JsonDict:
         """Get one document with given document identifier.
 
         Args:
             document_id: Unique identifier of the document.
-
+            fields: Document attributes to show. If this value is None then all
+                attributes are retrieved. Defaults to None.
+            retrieve_vectors: If set to True the embedding vectors will be returned with the document.
+                Defaults to False. Note: This parameter can only be
+                used with Meilisearch >= v1.13.0
         Returns:
             The document information
 
@@ -1307,7 +1317,16 @@ class AsyncIndex(_BaseIndex):
             >>>     index = client.index("movies")
             >>>     document = await index.get_document("1234")
         """
-        response = await self._http_requests.get(f"{self._documents_url}/{document_id}")
+        parameters: JsonDict = {}
+
+        if fields:
+            parameters["fields"] = ",".join(fields)
+        if retrieve_vectors:
+            parameters["retrieveVectors"] = "true"
+
+        url = _build_encoded_url(f"{self._documents_url}/{document_id}", parameters)
+
+        response = await self._http_requests.get(url)
 
         return response.json()
 
@@ -1318,6 +1337,7 @@ class AsyncIndex(_BaseIndex):
         limit: int = 20,
         fields: list[str] | None = None,
         filter: Filter | None = None,
+        retrieve_vectors: bool = False,
     ) -> DocumentsInfo:
         """Get a batch documents from the index.
 
@@ -1328,6 +1348,9 @@ class AsyncIndex(_BaseIndex):
                 attributes are retrieved. Defaults to None.
             filter: Filter value information. Defaults to None. Note: This parameter can only be
                 used with Meilisearch >= v1.2.0
+            retrieve_vectors: If set to True the vectors will be returned with each document.
+                Defaults to False. Note: This parameter can only be
+                used with Meilisearch >= v1.13.0
 
         Returns:
             Documents info.
@@ -1348,6 +1371,9 @@ class AsyncIndex(_BaseIndex):
             "limit": limit,
         }
 
+        if retrieve_vectors:
+            parameters["retrieveVectors"] = "true"
+
         if not filter:
             if fields:
                 parameters["fields"] = ",".join(fields)
@@ -5470,12 +5496,22 @@ class Index(_BaseIndex):
 
         return SimilarSearchResults[self.hits_type](**response.json())  # type: ignore[name-defined]
 
-    def get_document(self, document_id: str) -> JsonDict:
+    def get_document(
+        self,
+        document_id: str,
+        *,
+        fields: list[str] | None = None,
+        retrieve_vectors: bool = False,
+    ) -> JsonDict:
         """Get one document with given document identifier.
 
         Args:
             document_id: Unique identifier of the document.
-
+            fields: Document attributes to show. If this value is None then all
+                attributes are retrieved. Defaults to None.
+            retrieve_vectors: If set to True the embedding vectors will be returned with the document.
+                Defaults to False. Note: This parameter can only be
+                used with Meilisearch >= v1.13.0
         Returns:
             The document information
 
@@ -5489,8 +5525,16 @@ class Index(_BaseIndex):
             >>> index = client.index("movies")
             >>> document = index.get_document("1234")
         """
-        response = self._http_requests.get(f"{self._documents_url}/{document_id}")
+        parameters: JsonDict = {}
+
+        if fields:
+            parameters["fields"] = ",".join(fields)
+        if retrieve_vectors:
+            parameters["retrieveVectors"] = "true"
 
+        url = _build_encoded_url(f"{self._documents_url}/{document_id}", parameters)
+
+        response = self._http_requests.get(url)
         return response.json()
 
     def get_documents(
@@ -5500,6 +5544,7 @@ class Index(_BaseIndex):
         limit: int = 20,
         fields: list[str] | None = None,
         filter: Filter | None = None,
+        retrieve_vectors: bool = False,
     ) -> DocumentsInfo:
         """Get a batch documents from the index.
 
@@ -5510,6 +5555,9 @@ class Index(_BaseIndex):
                 attributes are retrieved. Defaults to None.
             filter: Filter value information. Defaults to None. Note: This parameter can only be
                 used with Meilisearch >= v1.2.0
+            retrieve_vectors: If set to True the vectors will be returned with each document.
+                Defaults to False. Note: This parameter can only be
+                used with Meilisearch >= v1.13.0
 
         Returns:
             Documents info.
@@ -5530,6 +5578,9 @@ class Index(_BaseIndex):
             "limit": limit,
         }
 
+        if retrieve_vectors:
+            parameters["retrieveVectors"] = "true"
+
         if not filter:
             if fields:
                 parameters["fields"] = ",".join(fields)

{meilisearch_python_sdk-4.3.0.dist-info → meilisearch_python_sdk-4.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 4.3.0
+Version: 4.4.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.3.0.dist-info → meilisearch_python_sdk-4.4.0.dist-info}/RECORD

@@ -4,10 +4,10 @@ meilisearch_python_sdk/_client.py,sha256=6nMAYLiRF0uPC52qL8VnlbrUGEkJ8IkU7zyJvtq
 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=87k8M7teNYc_YuHeeXhRST1xfRF9fxUp-gWUQLUp_ac,18
+meilisearch_python_sdk/_version.py,sha256=oB0KqP42eLvdXDCkFa6G9Qy-3YoRoU2ADk6AzWBWU9E,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=ipJ0L7gZuDYPSnqEz80Ow5lmUQkAHy0W8KMLkNn6Xsw,342333
+meilisearch_python_sdk/index.py,sha256=IJZ1s_3Qusryzf923fDGG1m44rXV1zGc7whMuS41EPw,344420
 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
@@ -22,7 +22,7 @@ meilisearch_python_sdk/models/search.py,sha256=ZySZyA18QuJavz82gK7Kkqfp0fIxWVerv
 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.3.0.dist-info/METADATA,sha256=ZqUS7d7tj7DMrm6fZeF_YbDhHZ4pLrwis8FAYudsQZA,9763
-meilisearch_python_sdk-4.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-meilisearch_python_sdk-4.3.0.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
-meilisearch_python_sdk-4.3.0.dist-info/RECORD,,
+meilisearch_python_sdk-4.4.0.dist-info/METADATA,sha256=Q0-zQ-P-fCnYnYieWx4Jh5HHTbb_zLApt5fhz1rf80g,9763
+meilisearch_python_sdk-4.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+meilisearch_python_sdk-4.4.0.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
+meilisearch_python_sdk-4.4.0.dist-info/RECORD,,