Merge pull request #1492 from sanders41/get-documents-ids

Add ability to get documents by ids

Author: sanders41

meilisearch_python_sdk/index.py

@@ -1372,6 +1372,7 @@ async def get_document(
     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 @@ async def get_documents(
         """Get a batch documents from the index.
 
         Args:
+            ids: Array of document primary keys to retrieve. Defults 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 @@ async def get_documents(
         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 @@ async def get_documents(
 
         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())
@@ -5640,6 +5645,7 @@ def get_document(
     def get_documents(
         self,
         *,
+        ids: list[str] | None = None,
         offset: int = 0,
         limit: int = 20,
         fields: list[str] | None = None,
@@ -5650,6 +5656,7 @@ def get_documents(
         """Get a batch documents from the index.
 
         Args:
+            ids: Array of document primary keys to retrieve. Defults 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 @@ def get_documents(
         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 @@ def get_documents(
 
         parameters["filter"] = filter
 
+        if ids:
+            parameters["ids"] = ids
+
         response = self._http_requests.post(f"{self._documents_url}/fetch", body=parameters)
 
         return DocumentsInfo(**response.json())

tests/test_async_documents.py

@@ -748,6 +748,18 @@ async def test_get_documents_filter(async_index_with_documents):
     assert next(iter(genres)) == "action"
 
 
+async def test_get_documents_ids(async_index_with_documents):
+    index = await async_index_with_documents()
+    documents = await index.get_documents()
+    assert len(documents.results) > 2
+    ids = [documents.results[0]["id"], documents.results[1]["id"]]
+    response = await index.get_documents(ids=ids)
+    assert len(response.results) == 2
+    retrieved_ids = [result["id"] for result in response.results]
+    assert ids[0] in retrieved_ids
+    assert ids[1] in retrieved_ids
+
+
 async def test_get_documents_filter_with_fields(async_index_with_documents):
     index = await async_index_with_documents()
     response = await index.update_filterable_attributes(["genre"])

tests/test_documents.py

@@ -668,6 +668,18 @@ def test_get_documents_filter(index_with_documents):
     assert next(iter(genres)) == "action"
 
 
+def test_get_documents_ids(index_with_documents):
+    index = index_with_documents()
+    documents = index.get_documents()
+    assert len(documents.results) > 2
+    ids = [documents.results[0]["id"], documents.results[1]["id"]]
+    response = index.get_documents(ids=ids)
+    assert len(response.results) == 2
+    retrieved_ids = [result["id"] for result in response.results]
+    assert ids[0] in retrieved_ids
+    assert ids[1] in retrieved_ids
+
+
 def test_get_documents_with_vectors(index_with_documents):
     index = index_with_documents()
     response = index.update_filterable_attributes(["genre"])