Merge 'feat/vector-retry' into 'master'

feat: add retry and Ping

See merge request: !16

Author: ZaynJarvis

examples/memory/04_exception_handling_test.py

@@ -63,4 +63,3 @@ def add_session_exception():
     print("Viking Memory Add Session Messages Example\n")
 
     add_session_exception()
-    

examples/vector/E3_1_index_search_multimodal_test.py

@@ -69,7 +69,7 @@ def test_snippet_index_search_multimodal() -> None:
     for payload in chapters:
         collection_client.upsert(UpsertDataRequest(data=[payload]))
 
-    time.sleep(3)
+    time.sleep(2)
 
     filter_map = {"op": "range", "field": "paragraph", "gte": base_paragraph, "lte": base_paragraph + 1}
     search_req = SearchByMultiModalRequest(
@@ -102,7 +102,7 @@ def test_scenario_index_search_multimodal(multimodal_clients: Clients) -> None:
                 request_options=request_options,
             )
 
-        time.sleep(3)
+        time.sleep(2)
 
         filters = bool_and_filters(
             [

examples/vector/E3_2_index_search_vector_test.py

@@ -90,7 +90,7 @@ def test_v_snippet_index_search_vector() -> None:
         payload.append({**chapter, "vector": vector})
     collection_client.upsert(UpsertDataRequest(data=payload))
 
-    time.sleep(3)
+    time.sleep(2)
 
     query_req = EmbeddingRequest(
         data=[{"text": "Show me the chapter that demonstrates embedding reuse for query vectors."}],
@@ -144,7 +144,7 @@ def test_scenario_index_search_vector(vector_clients: Clients) -> None:
             )
         vector_clients.collection.upsert(UpsertDataRequest(data=payload), request_options=request_options)
 
-        time.sleep(3)
+        time.sleep(2)
 
         retrieval = next(ch for ch in chapters if ch.key == "retrieval-lab")
         query_vector = embed_dense_vectors(

examples/vector/E3_3_search_by_keyword_test.py

@@ -68,7 +68,7 @@ def test_snippet_search_keywords() -> None:
     for doc in documents:
         collection_client.upsert(UpsertDataRequest(data=[doc]))
 
-    time.sleep(3)
+    time.sleep(2)
 
     filter_map = {"op": "range", "field": "paragraph", "gte": base_paragraph, "lt": base_paragraph + len(documents)}
     search_req = SearchByKeywordsRequest(
@@ -90,6 +90,7 @@ def keyword_clients() -> Clients:
 def test_scenario_search_keywords(keyword_clients: Clients) -> None:
     session_tag = new_session_tag("index-extensions")
     request_options = build_request_options(session_tag)
+    request_options.max_attempts = 5
     base_paragraph = int(time.time()) % 1_000_000
     chapters = build_story_chapters(session_tag, base_paragraph)
 
@@ -100,7 +101,7 @@ def test_scenario_search_keywords(keyword_clients: Clients) -> None:
                 request_options=request_options,
             )
 
-        time.sleep(5)
+        time.sleep(2)
 
         filter_map = session_paragraph_bounds(base_paragraph, len(chapters))
         search_req = SearchByKeywordsRequest(

examples/vector/E4_search_aggregate_test.py

@@ -91,7 +91,7 @@ def test_scenario_search_extensions_and_analytics(aggregate_clients: Clients) ->
                 request_options=request_options,
             )
 
-        time.sleep(3)
+        time.sleep(2)
 
         agg_req = AggRequest(
             field="paragraph",

examples/vector/E6_exception_handling_test.py

@@ -6,8 +6,8 @@
 
 from vikingdb import IAM
 from vikingdb.exceptions import NETWORK_ERROR_CODE
-from vikingdb.vector import SearchByRandomRequest, VikingVector
-from vikingdb.vector.exceptions import VikingVectorException
+from vikingdb.vector import VikingVector
+from vikingdb.vector.exceptions import VikingVectorException, VikingConnectionException
 
 from .guide_helpers import EnvConfig, load_config
 
@@ -51,17 +51,7 @@ def test_exception_collection_not_exist() -> None:
 
 def test_exception_wrong_host_raises_network() -> None:
     """Using an invalid host should raise a network exception promoted to VikingVectorException."""
-    config, client = _build_vector_client(host_override="this-host-does-not-exist.invalid", timeout=1)
-
-    index_client = client.index(
-        collection_name=config.collection,
-        index_name=config.index,
-        project_name=config.project_name,
-        resource_id=config.resource_id,
-    )
-
-    with pytest.raises(VikingVectorException) as exc_info:
-        index_client.search_by_random(SearchByRandomRequest(limit=1))
-
-    error_code = str(exc_info.value.code)
-    assert "InternalServerError" in error_code
+    with pytest.raises(VikingConnectionException) as exc_info:
+        _build_vector_client(host_override="in-v-alid.io", timeout=1)
+    
+    assert exc_info

vikingdb/_client.py

@@ -81,7 +81,7 @@ def _build_service_info(
     def prepare_request(self, api_info: ApiInfo, params: Optional[Mapping[str, Any]], doseq: int = 0):
         """Prepare a volcengine request without adding implicit headers."""
         request = Request()
-        request.set_shema(self.service_info.scheme)
+        request.set_schema(self.service_info.scheme)
         request.set_method(api_info.method)
         request.set_host(self.service_info.host)
         request.set_path(api_info.path)

vikingdb/vector/client.py

@@ -4,6 +4,7 @@
 from __future__ import annotations
 
 import json
+import time
 from collections.abc import Mapping
 from typing import TYPE_CHECKING, Any, Optional
 
@@ -12,7 +13,7 @@
 from .._client import Client, _REQUEST_ID_HEADER
 from ..auth import Auth
 from ..exceptions import VikingException
-from .exceptions import VikingVectorException
+from .exceptions import VikingVectorException, VikingConnectionException
 from ..request_options import RequestOptions, ensure_request_options
 from ..version import __version__
 from .models import CollectionMeta, IndexMeta
@@ -64,6 +65,12 @@ def __init__(
             scheme=scheme,
             timeout=timeout,
         )
+        try:
+            resp = self.session.get(f"{scheme}://{host}/api/vikingdb/Ping")
+            if resp.status_code != 200:
+                raise VikingConnectionException(f"failed to ping {host}", f"{resp.status_code}")
+        except Exception as exp:
+            raise VikingConnectionException(f"failed to ping {host} ", str(exp))
 
     def collection(
         self,
@@ -112,6 +119,13 @@ def request(
         options: Optional[RequestOptions] = None,
     ) -> Mapping[str, object]:
         request_options = ensure_request_options(options)
+        max_attempts = (
+            request_options.max_attempts
+            if request_options.max_attempts and request_options.max_attempts > 0
+            else 3
+        )
+        initial_delay_seconds = 0.5
+        max_delay_seconds = 8.0
         headers = {
             "Accept": "application/json",
             "Content-Type": "application/json",
@@ -124,10 +138,26 @@ def request(
 
         body = json.dumps(payload, ensure_ascii=False, separators=(",", ":"))
         params = dict(request_options.query) if request_options.query else None
-        response_data = self.json_exception(api, params, body, headers=headers, timeout=request_options.timeout)
-        if not response_data:
-            return {}
-        return response_data
+        for attempt in range(1, max_attempts + 1):
+            try:
+                response_data = self.json_exception(
+                    api,
+                    params,
+                    body,
+                    headers=headers,
+                    timeout=request_options.timeout,
+                )
+                if not response_data:
+                    return {}
+                return response_data
+            except Exception:
+                if attempt >= max_attempts:
+                    raise
+                delay = min(
+                    initial_delay_seconds * (2 ** (attempt - 1)),
+                    max_delay_seconds,
+                )
+                time.sleep(delay)
 
     def json_exception(
         self,

vikingdb/vector/exceptions.py

@@ -7,6 +7,10 @@
 
 from ..exceptions import VikingException
 
+class VikingConnectionException(Exception):
+    def __init__(self, msg: str, cause: str) -> None:
+        super().__init__(msg, cause)
+        
 
 class VikingVectorException(VikingException):
     """Raised when the remote VikingDB service returns an error payload."""

vikingdb/version.py

@@ -1,4 +1,4 @@
 # Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd.
 # SPDX-License-Identifier: Apache-2.0
 
-__version__ = '0.1.0'
+__version__ = '0.1.1'