pyobvector 0.2.17__tar.gz → 0.2.18__tar.gz

{pyobvector-0.2.17 → pyobvector-0.2.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyobvector
-Version: 0.2.17
+Version: 0.2.18
 Summary: A python SDK for OceanBase Vector Store, based on SQLAlchemy, compatible with Milvus API.
 License-File: LICENSE
 Author: shanhaikang.shk
@@ -38,7 +38,7 @@ poetry install
 - install with pip:
 
 ```shell
-pip install pyobvector==0.2.17
+pip install pyobvector==0.2.18
 ```
 
 ## Build Doc
@@ -50,6 +50,10 @@ mkdir build
 make html
 ```
 
+## Release Notes
+
+For detailed release notes and changelog, see [RELEASE_NOTES.md](RELEASE_NOTES.md).
+
 ## Usage
 
 `pyobvector` supports two modes:

{pyobvector-0.2.17 → pyobvector-0.2.18}/README.md

@@ -15,7 +15,7 @@ poetry install
 - install with pip:
 
 ```shell
-pip install pyobvector==0.2.17
+pip install pyobvector==0.2.18
 ```
 
 ## Build Doc
@@ -27,6 +27,10 @@ mkdir build
 make html
 ```
 
+## Release Notes
+
+For detailed release notes and changelog, see [RELEASE_NOTES.md](RELEASE_NOTES.md).
+
 ## Usage
 
 `pyobvector` supports two modes:

{pyobvector-0.2.17 → pyobvector-0.2.18}/pyobvector/client/exceptions.py

@@ -111,5 +111,5 @@ class ExceptionsMessage:
     MetricTypeValueInvalid = "MetricType should be 'l2'/'ip'/'neg_ip'/'cosine' in ann search."
     UsingInIDsWhenMultiPrimaryKey = "Using 'ids' when table has multi primary key."
     ClusterVersionIsLow = (
-        "OceanBase Vector Store is not supported because cluster version is below 4.3.3.0."
+        "OceanBase %s feature is not supported because cluster version is below %s."
     )

pyobvector-0.2.18/pyobvector/client/hybrid_search.py

@@ -0,0 +1,81 @@
+"""OceanBase Hybrid Search Client."""
+import json
+import logging
+from typing import Dict, Any
+
+from sqlalchemy import text
+
+from .exceptions import ClusterVersionException, ErrorCode, ExceptionsMessage
+from .ob_vec_client import ObVecClient as Client
+from ..util import ObVersion
+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.DEBUG)
+
+
+class HybridSearch(Client):
+    """The OceanBase Hybrid Search Client"""
+
+    def __init__(
+        self,
+        uri: str = "127.0.0.1:2881",
+        user: str = "root@test",
+        password: str = "",
+        db_name: str = "test",
+        **kwargs,
+    ):
+        super().__init__(uri, user, password, db_name, **kwargs)
+
+        if self.ob_version < ObVersion.from_db_version_nums(4, 4, 1, 0):
+            raise ClusterVersionException(
+                code=ErrorCode.NOT_SUPPORTED,
+                message=ExceptionsMessage.ClusterVersionIsLow % ("Hybrid Search", "4.4.1.0"),
+            )
+
+    def search(
+        self,
+        index: str,
+        body: Dict[str, Any],
+        **kwargs,
+    ):
+        """Execute hybrid search with parameter compatible with Elasticsearch.
+
+        Args:
+            index: The name of the table to search
+            body: The search query body
+            **kwargs: Additional search parameters
+
+        Returns:
+            Search results
+        """
+        body_str = json.dumps(body)
+
+        sql = text("SELECT DBMS_HYBRID_SEARCH.SEARCH(:index, :body_str)")
+
+        with self.engine.connect() as conn:
+            with conn.begin():
+                res = conn.execute(sql, {"index": index, "body_str": body_str}).fetchone()
+                return json.loads(res[0])
+
+    def get_sql(
+        self,
+        index: str,
+        body: Dict[str, Any],
+    ) -> str:
+        """Get the SQL actually to be executed in hybrid search.
+
+        Args:
+            index: The name of the table to search
+            body: The hybrid search query body
+
+        Returns:
+            The SQL actually to be executed
+        """
+        body_str = json.dumps(body)
+
+        sql = text("SELECT DBMS_HYBRID_SEARCH.GET_SQL(:index, :body_str)")
+
+        with self.engine.connect() as conn:
+            with conn.begin():
+                res = conn.execute(sql, {"index": index, "body_str": body_str}).fetchone()
+                return res[0]

{pyobvector-0.2.17 → pyobvector-0.2.18}/pyobvector/client/ob_vec_client.py

@@ -44,7 +44,7 @@ class ObVecClient(ObClient):
         if self.ob_version < ObVersion.from_db_version_nums(4, 3, 3, 0):
             raise ClusterVersionException(
                 code=ErrorCode.NOT_SUPPORTED,
-                message=ExceptionsMessage.ClusterVersionIsLow,
+                message=ExceptionsMessage.ClusterVersionIsLow % ("Vector Store", "4.3.3.0"),
             )
 
     def _get_sparse_vector_index_params(

{pyobvector-0.2.17 → pyobvector-0.2.18}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyobvector"
-version = "0.2.17"
+version = "0.2.18"
 description = "A python SDK for OceanBase Vector Store, based on SQLAlchemy, compatible with Milvus API."
 authors = ["shanhaikang.shk <shanhaikang.shk@oceanbase.com>"]
 readme = "README.md"