meilisearch-python-sdk 5.2.0__py3-none-any.whl → 5.3.0__py3-none-any.whl

meilisearch_python_sdk/_client.py

@@ -87,7 +87,7 @@ class BaseClient:
                 token.
             api_key: The API key to use to generate the token.
             expires_at: The timepoint at which the token should expire. If value is provided it
-                shoud be a UTC time in the future. Default = None.
+                should be a UTC time in the future. Default = None.
 
         Returns:
             A JWT token
@@ -1170,7 +1170,7 @@ class AsyncClient(BaseClient):
             timeout_in_ms: Amount of time in milliseconds to wait before raising a
                 MeilisearchTimeoutError. `None` can also be passed to wait indefinitely. Be aware that
                 if the `None` option is used the wait time could be very long. Defaults to 5000.
-            interval_in_ms: Time interval in miliseconds to sleep between requests. Defaults to 50.
+            interval_in_ms: Time interval in milliseconds to sleep between requests. Defaults to 50.
             raise_for_status: When set to `True` a MeilisearchTaskFailedError will be raised if a task
                 has a failed status. Defaults to False.
 
@@ -2271,7 +2271,7 @@ class Client(BaseClient):
             timeout_in_ms: Amount of time in milliseconds to wait before raising a
                 MeilisearchTimeoutError. `None` can also be passed to wait indefinitely. Be aware that
                 if the `None` option is used the wait time could be very long. Defaults to 5000.
-            interval_in_ms: Time interval in miliseconds to sleep between requests. Defaults to 50.
+            interval_in_ms: Time interval in milliseconds to sleep between requests. Defaults to 50.
             raise_for_status: When set to `True` a MeilisearchTaskFailedError will be raised if a task
                 has a failed status. Defaults to False.
 

meilisearch_python_sdk/_task.py

@@ -73,7 +73,7 @@ async def async_cancel_tasks(
     )
 
     if not parameters:
-        # Cancel all tasks if no parmaeters provided
+        # Cancel all tasks if no parameters provided
         parameters["statuses"] = "enqueued,processing"
 
     url = f"tasks/cancel?{urlencode(parameters)}"
@@ -107,7 +107,7 @@ async def async_delete_tasks(
     )
 
     if not parameters:
-        # delete all tasks if no parmaeters provided
+        # delete all tasks if no parameters provided
         parameters["statuses"] = "canceled,enqueued,failed,processing,succeeded"
 
     url = f"tasks?{urlencode(parameters)}"
@@ -214,7 +214,7 @@ def cancel_tasks(
     )
 
     if not parameters:
-        # Cancel all tasks if no parmaeters provided
+        # Cancel all tasks if no parameters provided
         parameters["statuses"] = "enqueued,processing"
 
     url = f"tasks/cancel?{urlencode(parameters)}"
@@ -248,7 +248,7 @@ def delete_tasks(
     )
 
     if not parameters:
-        # delete all tasks if no parmaeters provided
+        # delete all tasks if no parameters provided
         parameters["statuses"] = "canceled,enqueued,failed,processing,succeeded"
 
     url = f"tasks?{urlencode(parameters)}"

meilisearch_python_sdk/_version.py

@@ -1 +1 @@
-VERSION = "5.2.0"
+VERSION = "5.3.0"

meilisearch_python_sdk/decorators.py

@@ -10,7 +10,7 @@ from meilisearch_python_sdk._utils import use_task_groups
 
 
 class ConnectionInfo(NamedTuple):
-    """Infomation on how to connect to Meilisearch.
+    """Information on how to connect to Meilisearch.
 
     url: URL for the Meilisearch server.
     api_key: The API key for the server.
@@ -29,13 +29,13 @@ def async_add_documents(
     wait_for_task: bool = False,
     verify: bool = True,
 ) -> Callable:
-    """Decorator that takes the returned documents from a function and asyncronously adds them to Meilisearch.
+    """Decorator that takes the returned documents from a function and asynchronously adds them to Meilisearch.
 
     It is required that either an async_client or url is provided.
 
     Args:
         index_name: The name of the index to which the documents should be added.
-        connection_info: Either an AsyncClient instance ConnectionInfo with informtaion on how to
+        connection_info: Either an AsyncClient instance ConnectionInfo with information on how to
             connect to Meilisearch.
         batch_size: If provided the documents will be sent in batches of the specified size.
             Otherwise all documents are sent at once. Default = None.
@@ -46,7 +46,7 @@ def async_add_documents(
         verify: If set to `False` the decorator will not verify the SSL certificate of the server.
 
     Returns:
-        The list of documents proviced by the decorated function.
+        The list of documents provided by the decorated function.
 
     Raises:
         MeilisearchCommunicationError: If there was an error communicating with the server.
@@ -117,7 +117,7 @@ def add_documents(
 
     Args:
         index_name: The name of the index to which the documents should be added.
-        connection_info: Either an Client instance ConnectionInfo with informtaion on how to
+        connection_info: Either an Client instance ConnectionInfo with information on how to
             connect to Meilisearch.
         batch_size: If provided the documents will be sent in batches of the specified size.
             Otherwise all documents are sent at once. Default = None.
@@ -128,7 +128,7 @@ def add_documents(
         verify: If set to `False` the decorator will not verify the SSL certificate of the server.
 
     Returns:
-        The list of documents proviced by the decorated function.
+        The list of documents provided by the decorated function.
 
     Raises:
         MeilisearchCommunicationError: If there was an error communicating with the server.

meilisearch_python_sdk/index.py

@@ -562,7 +562,7 @@ class AsyncIndex(_BaseIndex):
         return self
 
     async def fetch_info(self) -> Self:
-        """Gets the infromation about the index.
+        """Gets the information about the index.
 
         Returns:
             An instance of the AsyncIndex containing the retrieved information.
@@ -757,7 +757,7 @@ class AsyncIndex(_BaseIndex):
             attributes_to_retrieve: Attributes to display in the returned documents.
                 Defaults to ["*"].
             attributes_to_crop: Attributes whose values have to be cropped. Defaults to None.
-            crop_length: The maximun number of words to display. Defaults to 200.
+            crop_length: The maximum number of words to display. Defaults to 200.
             attributes_to_highlight: Attributes whose values will contain highlighted matching terms.
                 Defaults to None.
             sort: Attributes by which to sort the results. Defaults to None.
@@ -765,7 +765,7 @@ class AsyncIndex(_BaseIndex):
                 matches should be returned or not. Defaults to False.
             highlight_pre_tag: The opening tag for highlighting text. Defaults to <em>.
             highlight_post_tag: The closing tag for highlighting text. Defaults to </em>
-            crop_marker: Marker to display when the number of words excedes the `crop_length`.
+            crop_marker: Marker to display when the number of words exceeds the `crop_length`.
                 Defaults to ...
             matching_strategy: Specifies the matching strategy Meilisearch should use. Defaults to
                 `last`.
@@ -1036,7 +1036,7 @@ class AsyncIndex(_BaseIndex):
             attributes_to_retrieve: Attributes to display in the returned documents.
                 Defaults to ["*"].
             attributes_to_crop: Attributes whose values have to be cropped. Defaults to None.
-            crop_length: The maximun number of words to display. Defaults to 200.
+            crop_length: The maximum number of words to display. Defaults to 200.
             attributes_to_highlight: Attributes whose values will contain highlighted matching terms.
                 Defaults to None.
             sort: Attributes by which to sort the results. Defaults to None.
@@ -1044,7 +1044,7 @@ class AsyncIndex(_BaseIndex):
                 matches should be returned or not. Defaults to False.
             highlight_pre_tag: The opening tag for highlighting text. Defaults to <em>.
             highlight_post_tag: The closing tag for highlighting text. Defaults to </em>
-            crop_marker: Marker to display when the number of words excedes the `crop_length`.
+            crop_marker: Marker to display when the number of words exceeds the `crop_length`.
                 Defaults to ...
             matching_strategy: Specifies the matching strategy Meilisearch should use. Defaults to
                 `last`.
@@ -1372,6 +1372,7 @@ class AsyncIndex(_BaseIndex):
     async def get_documents(
         self,
         *,
+        ids: list[str] | None = None,
         offset: int = 0,
         limit: int = 20,
         fields: list[str] | None = None,
@@ -1382,6 +1383,7 @@ class AsyncIndex(_BaseIndex):
         """Get a batch documents from the index.
 
         Args:
+            ids: Array of document primary keys to retrieve. Defaults to None (Gets all documents).
             offset: Number of documents to skip. Defaults to 0.
             limit: Maximum number of documents returnedd. Defaults to 20.
             fields: Document attributes to show. If this value is None then all
@@ -1418,7 +1420,7 @@ class AsyncIndex(_BaseIndex):
         if retrieve_vectors:
             parameters["retrieveVectors"] = "true"
 
-        if not filter:
+        if not filter and not ids:
             if fields:
                 parameters["fields"] = ",".join(fields)
 
@@ -1432,6 +1434,9 @@ class AsyncIndex(_BaseIndex):
 
         parameters["filter"] = filter
 
+        if ids:
+            parameters["ids"] = ids
+
         response = await self._http_requests.post(f"{self._documents_url}/fetch", body=parameters)
 
         return DocumentsInfo(**response.json())
@@ -1663,8 +1668,8 @@ class AsyncIndex(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
-                the field names, and ever for should have a title.
+                ndjson. For csv files the first row of the document should be a header row
+                containing the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
             combine_documents: If set to True this will combine the documents from all the files
@@ -1827,7 +1832,7 @@ class AsyncIndex(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
+                ndjson. For csv files the first row of the document should be a header row containing
                 the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
@@ -2350,7 +2355,7 @@ class AsyncIndex(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
+                ndjson. For csv files the first row of the document should be a header row containing
                 the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
@@ -2462,7 +2467,7 @@ class AsyncIndex(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
+                ndjson. For csv files the first row of the document should be a header row containing
                 the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
@@ -2907,7 +2912,7 @@ class AsyncIndex(_BaseIndex):
             MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples
-            >>> from meilisearch_pyrhon_sdk import AsyncClient
+            >>> from meilisearch_python_sdk import AsyncClient
             >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
             >>>     index = client.index("movies")
             >>>     await index.delete_documents_by_filter("genre=horor"))
@@ -5028,7 +5033,7 @@ class Index(_BaseIndex):
         return self
 
     def fetch_info(self) -> Self:
-        """Gets the infromation about the index.
+        """Gets the information about the index.
 
         Returns:
             An instance of the AsyncIndex containing the retrieved information.
@@ -5216,7 +5221,7 @@ class Index(_BaseIndex):
             attributes_to_retrieve: Attributes to display in the returned documents.
                 Defaults to ["*"].
             attributes_to_crop: Attributes whose values have to be cropped. Defaults to None.
-            crop_length: The maximun number of words to display. Defaults to 200.
+            crop_length: The maximum number of words to display. Defaults to 200.
             attributes_to_highlight: Attributes whose values will contain highlighted matching terms.
                 Defaults to None.
             sort: Attributes by which to sort the results. Defaults to None.
@@ -5224,7 +5229,7 @@ class Index(_BaseIndex):
                 matches should be returned or not. Defaults to False.
             highlight_pre_tag: The opening tag for highlighting text. Defaults to <em>.
             highlight_post_tag: The closing tag for highlighting text. Defaults to </em>
-            crop_marker: Marker to display when the number of words excedes the `crop_length`.
+            crop_marker: Marker to display when the number of words exceeds the `crop_length`.
                 Defaults to ...
             matching_strategy: Specifies the matching strategy Meilisearch should use. Defaults to
                 `last`.
@@ -5401,7 +5406,7 @@ class Index(_BaseIndex):
             attributes_to_retrieve: Attributes to display in the returned documents.
                 Defaults to ["*"].
             attributes_to_crop: Attributes whose values have to be cropped. Defaults to None.
-            crop_length: The maximun number of words to display. Defaults to 200.
+            crop_length: The maximum number of words to display. Defaults to 200.
             attributes_to_highlight: Attributes whose values will contain highlighted matching terms.
                 Defaults to None.
             sort: Attributes by which to sort the results. Defaults to None.
@@ -5409,7 +5414,7 @@ class Index(_BaseIndex):
                 matches should be returned or not. Defaults to False.
             highlight_pre_tag: The opening tag for highlighting text. Defaults to <em>.
             highlight_post_tag: The closing tag for highlighting text. Defaults to </em>
-            crop_marker: Marker to display when the number of words excedes the `crop_length`.
+            crop_marker: Marker to display when the number of words exceeds the `crop_length`.
                 Defaults to ...
             matching_strategy: Specifies the matching strategy Meilisearch should use. Defaults to
                 `last`.
@@ -5640,6 +5645,7 @@ class Index(_BaseIndex):
     def get_documents(
         self,
         *,
+        ids: list[str] | None = None,
         offset: int = 0,
         limit: int = 20,
         fields: list[str] | None = None,
@@ -5650,6 +5656,7 @@ class Index(_BaseIndex):
         """Get a batch documents from the index.
 
         Args:
+            ids: Array of document primary keys to retrieve. Defaults to None (Gets all documents).
             offset: Number of documents to skip. Defaults to 0.
             limit: Maximum number of documents returnedd. Defaults to 20.
             fields: Document attributes to show. If this value is None then all
@@ -5686,7 +5693,7 @@ class Index(_BaseIndex):
         if retrieve_vectors:
             parameters["retrieveVectors"] = "true"
 
-        if not filter:
+        if not filter and not ids:
             if fields:
                 parameters["fields"] = ",".join(fields)
 
@@ -5700,6 +5707,9 @@ class Index(_BaseIndex):
 
         parameters["filter"] = filter
 
+        if ids:
+            parameters["ids"] = ids
+
         response = self._http_requests.post(f"{self._documents_url}/fetch", body=parameters)
 
         return DocumentsInfo(**response.json())
@@ -5817,7 +5827,7 @@ class Index(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
+                ndjson. For csv files the first row of the document should be a header row containing
                 the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
@@ -5893,7 +5903,7 @@ class Index(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
+                ndjson. For csv files the first row of the document should be a header row containing
                 the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
@@ -6282,7 +6292,7 @@ class Index(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
+                ndjson. For csv files the first row of the document should be a header row containing
                 the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
@@ -6357,8 +6367,8 @@ class Index(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
-                the field names, and ever for should have a title.
+                ndjson. For csv files the first row of the document should be a header row
+                containing the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
             combine_documents: If set to True this will combine the documents from all the files

{meilisearch_python_sdk-5.2.0.dist-info → meilisearch_python_sdk-5.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 5.2.0
+Version: 5.3.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
@@ -252,7 +252,7 @@ Meilisearch takes to index the documents since that is outside of the library fu
 
 ![Add Documents in Batches](https://raw.githubusercontent.com/sanders41/meilisearch-python-sdk/main/assets/add_in_batches.png)
 
-### Muiltiple Searches
+### Multiple Searches
 
 This test compares how long it takes to complete 1000 searches (lower is better)
 

{meilisearch_python_sdk-5.2.0.dist-info → meilisearch_python_sdk-5.3.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=tQYQGPx9n65_DwG7elPCXP_reo60iZLlUuARFjdZ_xc,91501
+meilisearch_python_sdk/_client.py,sha256=wDGeki-lZx9IHQhtkN5JY4Z_W0K7c2MnR7q0tvSfCZU,91504
 meilisearch_python_sdk/_http_requests.py,sha256=9NMTKrJDFpdWZKPLNGlRQ54EtqhPXlhov3EoeR3VrwU,6773
-meilisearch_python_sdk/_task.py,sha256=QgVcqMlZdURRS_oYpB_bTBa5dvT3Sp_-O0-s6TqAxHk,12485
+meilisearch_python_sdk/_task.py,sha256=vZuBozL0qQDJBwEGgq6mrmYjJPBNi_NzCMk_uql0tsA,12485
 meilisearch_python_sdk/_utils.py,sha256=NoCDxJPhjABeuSxFTNCih585UDWdXEUBD_FvdgtScQw,1539
-meilisearch_python_sdk/_version.py,sha256=xnV4g8AF7GQs0JPTNPF2mR8BbbCQJq77p36hUdvbuKM,18
-meilisearch_python_sdk/decorators.py,sha256=xtG-ptJkVbPlbC1hJQ6dPgPYqU27VluGwL_CTJuIq3I,8701
+meilisearch_python_sdk/_version.py,sha256=CiZ4Q0e8bsMieE5CwowPjU5odGERRC1IIpiMtSINDUg,18
+meilisearch_python_sdk/decorators.py,sha256=6v630usrbHS8KFxgEI1U_STo3QWDnwGzOnbq7NPGp_0,8703
 meilisearch_python_sdk/errors.py,sha256=RNNHXtXLBiCVZaLM2MeKKs9RbRuE-SLRttiPeVAEXgA,2133
-meilisearch_python_sdk/index.py,sha256=WaK6Y1_yITPseJXclictQIXx8DVyKYGcHFwAD05ArYQ,352581
+meilisearch_python_sdk/index.py,sha256=jK0a73goCup_V1jMZ6MlrmaAlrp_MGCe-q-zRfP9gko,352995
 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
@@ -23,7 +23,7 @@ meilisearch_python_sdk/models/settings.py,sha256=eh0xnro4D_sj8ck2nifa3tBdf2_7RcZ
 meilisearch_python_sdk/models/task.py,sha256=JVYF46ylD-XwqVVNq2offhLOkljaGxPyRVuF6PwLOBU,2174
 meilisearch_python_sdk/models/version.py,sha256=ISU-ZHgpXLBFDuMpWWfKdVo9Dq1HcD7s6HFnCiGTF8Y,184
 meilisearch_python_sdk/models/webhook.py,sha256=zSkEJJdEflinW3_seJTLQ_ZWs4w-pjTD3SS1ZawC32k,455
-meilisearch_python_sdk-5.2.0.dist-info/METADATA,sha256=4R9DzaFZcYO26ByXDvbP1E2yOjAD7_gL3PgzHWZepGk,9730
-meilisearch_python_sdk-5.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-meilisearch_python_sdk-5.2.0.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
-meilisearch_python_sdk-5.2.0.dist-info/RECORD,,
+meilisearch_python_sdk-5.3.0.dist-info/METADATA,sha256=jvCbYsvySP6BLzw40o1K_b4QCpzkynEf1wI96L9gI6Q,9729
+meilisearch_python_sdk-5.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+meilisearch_python_sdk-5.3.0.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
+meilisearch_python_sdk-5.3.0.dist-info/RECORD,,