Merge branch 'main' into update_doc_by_func

Author: MuddyHope

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.8.4-buster
+FROM python:3.9-buster
 
 COPY Pipfile .
 COPY Pipfile.lock .

Pipfile.lock

@@ -17,13 +17,16 @@
 
 
 class HttpRequests:
-    def __init__(self, config: Config) -> None:
+    def __init__(self, config: Config, custom_headers: Optional[Mapping[str, str]] = None) -> None:
         self.config = config
         self.headers = {
             "Authorization": f"Bearer {self.config.api_key}",
             "User-Agent": _build_user_agent(config.client_agents),
         }
 
+        if custom_headers is not None:
+            self.headers.update(custom_headers)
+
     def send_request(
         self,
         http_method: Callable,

meilisearch/_httprequests.py

@@ -34,6 +34,7 @@ def __init__(
         api_key: Optional[str] = None,
         timeout: Optional[int] = None,
         client_agents: Optional[Tuple[str, ...]] = None,
+        custom_headers: Optional[Mapping[str, str]] = None,
     ) -> None:
         """
         Parameters
@@ -48,10 +49,13 @@ def __init__(
         client_agents (optional):
             Used to send additional client agent information for clients extending the functionality
             of this client.
+        custom_headers (optional):
+            Custom headers to add when sending data to Meilisearch.
         """
+
         self.config = Config(url, api_key, timeout=timeout, client_agents=client_agents)
 
-        self.http = HttpRequests(self.config)
+        self.http = HttpRequests(self.config, custom_headers)
 
         self.task_handler = TaskHandler(self.config)
 

meilisearch/client.py

@@ -30,9 +30,11 @@
     HuggingFaceEmbedder,
     IndexStats,
     LocalizedAttributes,
+    OllamaEmbedder,
     OpenAiEmbedder,
     Pagination,
     ProximityPrecision,
+    RestEmbedder,
     TypoTolerance,
     UserProvidedEmbedder,
 )
@@ -281,12 +283,7 @@ def search(self, query: str, opt_params: Optional[Mapping[str, Any]] = None) ->
             String containing the searched word(s)
         opt_params (optional):
             Dictionary containing optional query parameters.
-            Note: The vector parameter is only available in Meilisearch >= v1.3.0, and is experimental
-            Meilisearch v1.3.0. In order to use this feature in Meilisearch v1.3.0 you first need to
-            enable the feature by sending a PATCH request to /experimental-features with
-            { "vectoreStore": true }. Because this feature is experimental it may be removed or
-            updated causing breaking changes in this library without a major version bump so use
-            with caution.
+            Note: The vector parameter is only available in Meilisearch >= v1.13.0
             https://www.meilisearch.com/docs/reference/api/search#search-in-an-index
 
         Returns
@@ -958,12 +955,23 @@ def get_settings(self) -> Dict[str, Any]:
         )
 
         if settings.get("embedders"):
-            embedders: dict[str, OpenAiEmbedder | HuggingFaceEmbedder | UserProvidedEmbedder] = {}
+            embedders: dict[
+                str,
+                OpenAiEmbedder
+                | HuggingFaceEmbedder
+                | OllamaEmbedder
+                | RestEmbedder
+                | UserProvidedEmbedder,
+            ] = {}
             for k, v in settings["embedders"].items():
                 if v.get("source") == "openAi":
                     embedders[k] = OpenAiEmbedder(**v)
+                elif v.get("source") == "ollama":
+                    embedders[k] = OllamaEmbedder(**v)
                 elif v.get("source") == "huggingFace":
                     embedders[k] = HuggingFaceEmbedder(**v)
+                elif v.get("source") == "rest":
+                    embedders[k] = RestEmbedder(**v)
                 else:
                     embedders[k] = UserProvidedEmbedder(**v)
 
@@ -1886,12 +1894,23 @@ def get_embedders(self) -> Embedders | None:
         if not response:
             return None
 
-        embedders: dict[str, OpenAiEmbedder | HuggingFaceEmbedder | UserProvidedEmbedder] = {}
+        embedders: dict[
+            str,
+            OpenAiEmbedder
+            | HuggingFaceEmbedder
+            | OllamaEmbedder
+            | RestEmbedder
+            | UserProvidedEmbedder,
+        ] = {}
         for k, v in response.items():
             if v.get("source") == "openAi":
                 embedders[k] = OpenAiEmbedder(**v)
+            elif v.get("source") == "ollama":
+                embedders[k] = OllamaEmbedder(**v)
             elif v.get("source") == "huggingFace":
                 embedders[k] = HuggingFaceEmbedder(**v)
+            elif v.get("source") == "rest":
+                embedders[k] = RestEmbedder(**v)
             else:
                 embedders[k] = UserProvidedEmbedder(**v)
 

meilisearch/index.py

@@ -54,18 +54,26 @@ class ProximityPrecision(str, Enum):
     BY_ATTRIBUTE = "byAttribute"
 
 
+class EmbedderDistribution(CamelBase):
+    mean: float
+    sigma: float
+
+
 class LocalizedAttributes(CamelBase):
     attribute_patterns: List[str]
     locales: List[str]
 
 
 class OpenAiEmbedder(CamelBase):
     source: str = "openAi"
+    url: Optional[str] = None
     model: Optional[str] = None  # Defaults to text-embedding-3-small
     dimensions: Optional[int] = None  # Uses the model default
     api_key: Optional[str] = None  # Can be provided through a CLI option or environment variable
     document_template: Optional[str] = None
     document_template_max_bytes: Optional[int] = None  # Default to 400
+    distribution: Optional[EmbedderDistribution] = None
+    binary_quantized: Optional[bool] = None
 
 
 class HuggingFaceEmbedder(CamelBase):
@@ -74,12 +82,45 @@ class HuggingFaceEmbedder(CamelBase):
     revision: Optional[str] = None
     document_template: Optional[str] = None
     document_template_max_bytes: Optional[int] = None  # Default to 400
+    distribution: Optional[EmbedderDistribution] = None
+    binary_quantized: Optional[bool] = None
+
+
+class OllamaEmbedder(CamelBase):
+    source: str = "ollama"
+    url: Optional[str] = None
+    api_key: Optional[str] = None
+    model: str
+    document_template: Optional[str] = None
+    document_template_max_bytes: Optional[int] = None  # Default to 400
+    distribution: Optional[EmbedderDistribution] = None
+    binary_quantized: Optional[bool] = None
+
+
+class RestEmbedder(CamelBase):
+    source: str = "rest"
+    url: str
+    api_key: Optional[str]  # required for protected APIs
+    document_template: Optional[str] = None
+    document_template_max_bytes: Optional[int] = None  # Default to 400
+    request: Dict[str, Any]
+    response: Dict[str, Any]
+    distribution: Optional[EmbedderDistribution] = None
+    headers: Optional[Dict[str, Any]] = None
+    binary_quantized: Optional[bool] = None
 
 
 class UserProvidedEmbedder(CamelBase):
     source: str = "userProvided"
     dimensions: int
+    distribution: Optional[EmbedderDistribution] = None
+    binary_quantized: Optional[bool] = None
 
 
 class Embedders(CamelBase):
-    embedders: Dict[str, Union[OpenAiEmbedder, HuggingFaceEmbedder, UserProvidedEmbedder]]
+    embedders: Dict[
+        str,
+        Union[
+            OpenAiEmbedder, HuggingFaceEmbedder, OllamaEmbedder, RestEmbedder, UserProvidedEmbedder
+        ],
+    ]

meilisearch/models/index.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/models/key.py

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

meilisearch/version.py

@@ -1,5 +1,7 @@
 # pylint: disable=invalid-name
 
+import pytest
+
 import meilisearch
 from tests import BASE_URL, MASTER_KEY
 
@@ -26,3 +28,33 @@ def test_client_timeout_not_set():
     response = client.health()
     assert client.config.timeout == default_timeout
     assert response["status"] == "available"
+
+
+@pytest.mark.parametrize(
+    "api_key, custom_headers, expected",
+    (
+        ("testKey", None, {"Authorization": "Bearer testKey"}),
+        (
+            "testKey",
+            {"header_key_1": "header_value_1", "header_key_2": "header_value_2"},
+            {
+                "Authorization": "Bearer testKey",
+                "header_key_1": "header_value_1",
+                "header_key_2": "header_value_2",
+            },
+        ),
+        (
+            None,
+            {"header_key_1": "header_value_1", "header_key_2": "header_value_2"},
+            {
+                "header_key_1": "header_value_1",
+                "header_key_2": "header_value_2",
+            },
+        ),
+        (None, None, {}),
+    ),
+)
+def test_headers(api_key, custom_headers, expected):
+    client = meilisearch.Client("127.0.0.1:7700", api_key=api_key, custom_headers=custom_headers)
+
+    assert client.http.headers.items() >= expected.items()

tests/client/test_client.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_key_meilisearch.py

@@ -2,7 +2,6 @@
 import json
 from typing import Optional
 
-import requests
 from pytest import fixture
 
 import meilisearch
@@ -206,6 +205,27 @@ 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

tests/conftest.py

@@ -265,7 +265,6 @@ def test_get_documents_filter_with_fields(index_with_documents):
     assert next(iter(genres)) == "action"
 
 
-@pytest.mark.usefixtures("enable_vector_search")
 def test_get_similar_documents(empty_index):
     index = empty_index()
     index.update_embedders({"manual": {"source": "userProvided", "dimensions": 3}})

tests/index/test_index_document_meilisearch.py

@@ -502,7 +502,6 @@ def test_show_ranking_score(index_with_documents):
     assert response["hits"][0]["_rankingScore"] >= 0.9
 
 
-@pytest.mark.usefixtures("enable_vector_search")
 def test_vector_search(index_with_documents_and_vectors):
     response = index_with_documents_and_vectors().search(
         "",

tests/index/test_index_search_meilisearch.py

@@ -41,7 +41,6 @@ def test_get_settings_default(empty_index):
     assert response["synonyms"] == {}
 
 
-@pytest.mark.usefixtures("enable_vector_search")
 def test_update_settings(new_settings, empty_index):
     """Tests updating some settings."""
     index = empty_index()
@@ -61,7 +60,6 @@ def test_update_settings(new_settings, empty_index):
     assert isinstance(response["embedders"]["open_ai"], OpenAiEmbedder)
 
 
-@pytest.mark.usefixtures("enable_vector_search")
 def test_reset_settings(new_settings, empty_index):
     """Tests resetting all the settings to their default value."""
     index = empty_index()
@@ -94,4 +92,4 @@ def test_reset_settings(new_settings, empty_index):
     assert response["searchableAttributes"] == ["*"]
     assert response["stopWords"] == []
     assert response["synonyms"] == {}
-    assert response.get("embedders") is None
+    assert response["embedders"] == {}

tests/settings/test_settings.py

@@ -1,18 +1,15 @@
 # pylint: disable=redefined-outer-name
-import pytest
 
 from meilisearch.models.index import OpenAiEmbedder, UserProvidedEmbedder
 
 
-@pytest.mark.usefixtures("enable_vector_search")
 def test_get_default_embedders(empty_index):
     """Tests getting default embedders."""
     response = empty_index().get_embedders()
 
     assert response is None
 
 
-@pytest.mark.usefixtures("enable_vector_search")
 def test_update_embedders_with_user_provided_source(new_embedders, empty_index):
     """Tests updating embedders."""
     index = empty_index()
@@ -24,7 +21,6 @@ def test_update_embedders_with_user_provided_source(new_embedders, empty_index):
     assert isinstance(response_get.embedders["open_ai"], OpenAiEmbedder)
 
 
-@pytest.mark.usefixtures("enable_vector_search")
 def test_reset_embedders(new_embedders, empty_index):
     """Tests resetting the typo_tolerance setting to its default value."""
     index = empty_index()