pyobvector 0.2.17__py3-none-any.whl → 0.2.18__py3-none-any.whl

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/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/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.dist-info → pyobvector-0.2.18.dist-info}/METADATA

@@ -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.dist-info → pyobvector-0.2.18.dist-info}/RECORD

@@ -2,12 +2,13 @@ pyobvector/__init__.py,sha256=5RtWI_ol3qxj_m7UXTQzByTmGZdIiQ0yyCyHZUhRDas,3888
 pyobvector/client/__init__.py,sha256=fDK2FVdSm3-XCwTqsam7zisic5UMhANUq97r29i27nc,2819
 pyobvector/client/collection_schema.py,sha256=a7JQk83ZxMsvMDGt5CC_4lz2-skONqKgk-OGUz297hM,5538
 pyobvector/client/enum.py,sha256=3lPjSltITSE694-qOAP4yoX6fzCjKD4WAewmIxFs49o,139
-pyobvector/client/exceptions.py,sha256=09WNeWA0g7DWATVNGSX6ZJR_NoaGIZ4NB9M-BtQNYO8,3784
+pyobvector/client/exceptions.py,sha256=CjoquSCc0H705MtvhpQW_F7_KaviYrKAHkndpF8sJx4,3777
 pyobvector/client/fts_index_param.py,sha256=UvU82p9_x444WAQMqhIUPHbqVHV5B3cFazje1Gw-slo,1105
+pyobvector/client/hybrid_search.py,sha256=RRjWGpSu625-ND-eZq0_JPL9OAP548XkOI9I9U-mTG4,2323
 pyobvector/client/index_param.py,sha256=Dg-FEFQPBRxb7qXChqoLgBSljpdJzF-C7ESUbG9x1mA,6926
 pyobvector/client/milvus_like_client.py,sha256=jHxB-ZmIGZiIDxEpurSlAKffiCF_KFNZP-14_vq1RQM,27887
 pyobvector/client/ob_client.py,sha256=csSRVWqbhnsaN2gj7FSwL7QExh4vbTx6EyqPznKRSz4,16172
-pyobvector/client/ob_vec_client.py,sha256=6w6jmHzqDZ938_bOzhz3NQDNe6BxEIwN8PwXQt2NPjU,19886
+pyobvector/client/ob_vec_client.py,sha256=P6IMtsYxS_S78VsQtltK3UenW91iYfRKa0s1hIc8CI0,19916
 pyobvector/client/ob_vec_json_table_client.py,sha256=rq80AfqAKhosLcrBFROAoINVSkr-48xlRH91Jt4pEwA,39246
 pyobvector/client/partitions.py,sha256=Bxwr5yVNlXwZc7SXBC03NeqL9giy4Fe6S2qZdHD8xGw,15621
 pyobvector/client/schema_type.py,sha256=gH2YiBsgkryo-R0GB_NYuRXMvzvrSjOamZTy6pwn2n0,1673
@@ -33,7 +34,7 @@ pyobvector/util/__init__.py,sha256=-opvZ4Ya0ByTAhls06547-zW3vkdYRkUH6W5OCKUHD4,3
 pyobvector/util/ob_version.py,sha256=cWkQWoJkIxG6OEF9-gBwJK8LUorltHuKSVAb_NFkpdE,1542
 pyobvector/util/sparse_vector.py,sha256=1IG0CRYfC2z39nGwuG43TImQkWiuPAXOlOnYqJ1hA-o,1275
 pyobvector/util/vector.py,sha256=58glSQqjOSTrGyNhUEIrs9r4F9oaYO_SdPNhMfbSnWs,2392
-pyobvector-0.2.17.dist-info/METADATA,sha256=84qltXOoooYKNqPE-gNyunQioq2AIIvIJB4qRxLGKJY,8965
-pyobvector-0.2.17.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-pyobvector-0.2.17.dist-info/licenses/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-pyobvector-0.2.17.dist-info/RECORD,,
+pyobvector-0.2.18.dist-info/METADATA,sha256=vqKxp4TJISXO73RxmXxqAPbzZERDoO-MwhPGruxYpXc,9068
+pyobvector-0.2.18.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+pyobvector-0.2.18.dist-info/licenses/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+pyobvector-0.2.18.dist-info/RECORD,,