Merge branch 'main' into feat/add-embedders-settings

Author: Strift

meilisearch/client.py

@@ -252,6 +252,33 @@ def multi_search(
             body={"queries": queries, "federation": federation},
         )
 
+    def update_documents_by_function(
+        self, index_uid: str, queries: Dict[str, List[Dict[str, Any]]]
+    ) -> Dict[str, Any]:
+        """Update Documents by function
+        Parameters
+        ----------
+        index_uid:
+            The index_uid where you want to update documents of.
+        queries:
+            List of dictionaries containing functions with or without filters that you want to use to update documents.
+
+        Returns
+        -------
+        task_info:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
+            https://www.meilisearch.com/docs/reference/api/tasks#get-one-task
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        return self.http.post(
+            path=f"{self.config.paths.index}/{index_uid}/{self.config.paths.document}/{self.config.paths.edit}",
+            body=dict(queries),
+        )
+
     def get_all_stats(self) -> Dict[str, Any]:
         """Get all stats of Meilisearch
 

meilisearch/config.py

@@ -44,6 +44,7 @@ class Paths:
         search_cutoff_ms = "search-cutoff-ms"
         proximity_precision = "proximity-precision"
         localized_attributes = "localized-attributes"
+        edit = "edit"
 
     def __init__(
         self,

meilisearch/models/key.py

@@ -10,7 +10,7 @@
 class _KeyBase(CamelBase):
     uid: str
     name: Optional[str] = None
-    description: str
+    description: Optional[str]
     actions: List[str]
     indexes: List[str]
     expires_at: Optional[datetime] = None

meilisearch/version.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-__version__ = "0.34.0"
+__version__ = "0.34.1"
 
 
 def qualified_version() -> str:

tests/client/test_client_key_meilisearch.py

@@ -46,6 +46,15 @@ def test_create_keys_default(client, test_key_info):
     assert key.indexes == test_key_info["indexes"]
 
 
+def test_create_keys_without_desc(client, test_nondescript_key_info):
+    """Tests the creation of a key with no optional argument."""
+    key = client.create_key(test_nondescript_key_info)
+    print(key)
+
+    assert key.name == "keyWithoutDescription"
+    assert key.description is None
+
+
 def test_create_keys_with_options(client, test_key_info):
     """Tests the creation of a key with arguments."""
     key = client.create_key(

tests/client/test_client_update_document_by_functions.py

@@ -0,0 +1,17 @@
+import pytest
+
+from tests.common import INDEX_UID
+
+
+@pytest.mark.usefixtures("enable_edit_documents_by_function")
+def test_update_document_by_function(client, index_with_documents):
+    """Delete the document with id and update document title"""
+    index_with_documents()
+    response = client.update_documents_by_function(
+        INDEX_UID,
+        {"function": 'if doc.id == "522681" {doc = () } else {doc.title = `* ${doc.title} *`}'},
+    )
+
+    assert isinstance(response, dict)
+    assert isinstance(response["taskUid"], int)
+    assert response["indexUid"] == INDEX_UID

tests/conftest.py

@@ -2,6 +2,7 @@
 import json
 from typing import Optional
 
+import requests
 from pytest import fixture
 
 import meilisearch
@@ -205,13 +206,68 @@ def test_key_info(client):
         pass
 
 
+@fixture(scope="function")
+def test_nondescript_key_info(client):
+    key_info = {
+        "name": "keyWithoutDescription",
+        "actions": ["search"],
+        "indexes": [common.INDEX_UID],
+        "expiresAt": None,
+    }
+
+    yield key_info
+
+    try:
+        keys = client.get_keys().results
+        key = next(x for x in keys if x.name == key_info["name"])
+        client.delete_key(key.key)
+    except MeilisearchApiError:
+        pass
+    except StopIteration:
+        pass
+
+
 @fixture(scope="function")
 def get_private_key(client):
     keys = client.get_keys().results
     key = next(x for x in keys if "Default Search API" in x.name)
     return key
 
 
+@fixture
+def enable_vector_search():
+    requests.patch(
+        f"{common.BASE_URL}/experimental-features",
+        headers={"Authorization": f"Bearer {common.MASTER_KEY}"},
+        json={"vectorStore": True},
+        timeout=10,
+    )
+    yield
+    requests.patch(
+        f"{common.BASE_URL}/experimental-features",
+        headers={"Authorization": f"Bearer {common.MASTER_KEY}"},
+        json={"vectorStore": False},
+        timeout=10,
+    )
+
+
+@fixture
+def enable_edit_documents_by_function():
+    requests.patch(
+        f"{common.BASE_URL}/experimental-features",
+        headers={"Authorization": f"Bearer {common.MASTER_KEY}"},
+        json={"editDocumentsByFunction": True},
+        timeout=10,
+    )
+    yield
+    requests.patch(
+        f"{common.BASE_URL}/experimental-features",
+        headers={"Authorization": f"Bearer {common.MASTER_KEY}"},
+        json={"editDocumentsByFunction": False},
+        timeout=10,
+    )
+
+
 @fixture
 def new_embedders():
     return {

tests/index/test_index_document_meilisearch.py

@@ -171,7 +171,6 @@ def test_update_documents_json_custom_serializer(empty_index):
 
 
 def test_update_documents_raw_custom_serializer(empty_index):
-
     documents = [
         {"id": uuid4(), "title": "test 1", "when": datetime.now()},
         {"id": uuid4(), "title": "Test 2", "when": datetime.now()},