vikingdb-python-sdk 0.1.10__tar.gz → 0.1.12__tar.gz

{vikingdb_python_sdk-0.1.10/vikingdb_python_sdk.egg-info → vikingdb_python_sdk-0.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vikingdb-python-sdk
-Version: 0.1.10
+Version: 0.1.12
 Summary: vikingdb Python SDK
 License: Apache-2.0
 Project-URL: Documentation, https://github.com/volcengine/volc-vikingdb-python-sdk/README.md

{vikingdb_python_sdk-0.1.10 → vikingdb_python_sdk-0.1.12}/vikingdb/_client.py

@@ -18,7 +18,7 @@ from volcengine.base.Request import Request
 from volcengine.base.Service import Service
 import requests
 
-from .auth import Auth, IAM, APIKey
+from .auth import Auth, IAM, APIKey, HeaderAuth
 from .exceptions import (
     DEFAULT_UNKNOWN_ERROR_CODE,
     VikingAPIException,
@@ -56,10 +56,10 @@ class Client(Service, ABC):
         # 判断auth是不是IAM 还是 APIKey类型
         if isinstance(auth, IAM):
             super().__init__(self.service_info, self.api_info)
-        elif isinstance(auth, APIKey):
+        elif isinstance(auth, (APIKey, HeaderAuth)):
             self.session = requests.session()
         else:
-            raise ValueError("auth must be IAM or APIKey type")
+            raise ValueError("auth must be IAM, APIKey or HeaderAuth type")
 
         if sts_token:
             self.set_session_token(session_token=sts_token)

{vikingdb_python_sdk-0.1.10 → vikingdb_python_sdk-0.1.12}/vikingdb/auth.py

@@ -6,6 +6,7 @@
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
+from typing import Mapping
 from volcengine.Credentials import Credentials
 from volcengine.auth.SignerV4 import SignerV4
 
@@ -66,3 +67,18 @@ class APIKey(Auth):
 
     def sign_request(self, request) -> None:
         request.headers["Authorization"] = f"Bearer {self.api_key}"
+
+
+class HeaderAuth(Auth):
+    """Header-based authentication provider."""
+
+    def __init__(self, headers: Mapping[str, str]):
+        self.headers = headers
+
+    def initialize(self, *, service: str, region: str):
+        return None
+
+    def sign_request(self, request) -> None:
+        if self.headers:
+            for key, value in self.headers.items():
+                request.headers[key] = value

{vikingdb_python_sdk-0.1.10 → vikingdb_python_sdk-0.1.12}/vikingdb/knowledge/collection.py

@@ -63,6 +63,12 @@ class KnowledgeCollection:
             if isinstance(request, Model)
             else dict(request)
         )
+        if request.file_path:
+
+
+
+            pass
+
         payload = {**self._meta_payload, **req_payload}
         res = self.client.json_exception("AddDocV2", {}, json.dumps(payload), headers=headers, timeout=timeout)
         response = AddDocResponse.parse_with(res)
@@ -261,3 +267,36 @@ class KnowledgeCollection:
         res = self.client.json_exception("SearchKnowledge", {}, json.dumps(payload), headers=headers, timeout=timeout)
         response = SearchKnowledgeResponse.parse_with(res)
         return response
+
+    def _upload_file(self, file_path: str) -> str:
+        with open(file_path, "rb") as f:
+            res = self.client.json_exception("UploadFile", {}, f.read())
+
+        # https://console.volcengine.com/api/top/vikingdb/cn-beijing/2025-04-01/GetKnowledgeBasePreSignedUrl?KnowledgeBaseId=kb-1e04481ba6a823c2&ProjectName=default
+        # {"TosPaths": ["2026_02_05_21_40_30rvbjCrtJycnAGsOFvXrphLN7F7VRsP2e/核心流程.md"]}
+        """
+        {
+            "Result": {
+                "PreSignedUrls": [
+                    "https://knowledgebase-fileupload.tos-cn-beijing.volces.com/ADD_DOC/2100655893/2026_02_05_21_40_30rvbjCrtJycnAGsOFvXrphLN7F7VRsP2e/%E6%A0%B8%E5%BF%83%E6%B5%81%E7%A8%8B.md?X-Tos-Algorithm=TOS4-HMAC-SHA256&X-Tos-Content-Sha256=UNSIGNED-PAYLOAD&X-Tos-Credential=AKLTOTg3ODc0NTAyYzU1NDIxNmJmODg1MWUyYTkwZDY3ZGM%2F20260205%2Ftos-cn-beijing.volces.com%2Ftos%2Frequest&X-Tos-Date=20260205T134045Z&X-Tos-Expires=300&X-Tos-SignedHeaders=host&X-Tos-Signature=712e8572edc6d251bf234cdb580246714c1ac9414e824ac1fe110772a6372fbc"
+                ],
+                "BucketName": "knowledgebase-fileupload"
+            },
+            "ResponseMetadata": {
+                "RequestId": "202602052140452A8D3265DCDE1911D17B",
+                "Action": "GetKnowledgeBasePreSignedUrl",
+                "Version": "2025-04-01",
+                "Service": "vikingdb",
+                "Region": "cn-beijing"
+            }
+        }
+        """
+
+        """
+        https://knowledgebase-fileupload.tos-cn-beijing.volces.com/ADD_DOC/2100655893/2026_02_05_21_40_30rvbjCrtJycnAGsOFvXrphLN7F7VRsP2e/%E6%A0%B8%E5%BF%83%E6%B5%81%E7%A8%8B.md?X-Tos-Algorithm=TOS4-HMAC-SHA256&X-Tos-Content-Sha256=UNSIGNED-PAYLOAD&X-Tos-Credential=AKLTOTg3ODc0NTAyYzU1NDIxNmJmODg1MWUyYTkwZDY3ZGM%2F20260205%2Ftos-cn-beijing.volces.com%2Ftos%2Frequest&X-Tos-Date=20260205T134045Z&X-Tos-Expires=300&X-Tos-SignedHeaders=host&X-Tos-Signature=712e8572edc6d251bf234cdb580246714c1ac9414e824ac1fe110772a6372fbc        
+        """
+
+
+
+        return res["data"]["uri"]
+

{vikingdb_python_sdk-0.1.10 → vikingdb_python_sdk-0.1.12}/vikingdb/knowledge/models/doc.py

@@ -41,6 +41,7 @@ class AddDocRequest(Model):
     doc_type: Optional[str] = Field(default=None, alias="doc_type")
     description: Optional[str] = Field(default=None, alias="description")
     tos_path: Optional[str] = Field(default=None, alias="tos_path")
+    file_path: Optional[str] = Field(default=None, alias="file_path")
     url: Optional[str] = Field(default=None, alias="url")
     lark_file: Optional[str] = Field(default=None, alias="lark_file")
     meta: Optional[List["MetaItem"]] = Field(default=None, alias="meta")
@@ -63,6 +64,7 @@ class AddDocV2Request(Model):
     description: Optional[str] = Field(default=None, alias="description")
     tag_list: Optional[List[MetaItem]] = Field(default=None, alias="tag_list")
     uri: Optional[str] = Field(default=None, alias="uri")
+    file_path: Optional[str] = Field(default=None, alias="file_path")
 
 class DedupInfo(Model):
     skip: Optional[bool] = Field(default=None, alias="skip")

{vikingdb_python_sdk-0.1.10 → vikingdb_python_sdk-0.1.12}/vikingdb/vector/models/index.py

@@ -95,9 +95,13 @@ class SearchByScalarRequest(SearchBase):
 
 
 class SearchByKeywordsRequest(SearchBase):
+    mode: Optional[str] = Field(default=None, alias="mode")
     keywords: Optional[Sequence[str]] = Field(default=None, alias="keywords")
     query: Optional[str] = Field(default=None, alias="query")
     case_sensitive: Optional[bool] = Field(default=None, alias="case_sensitive")
+    fields: Optional[Sequence[str]] = Field(default=None, alias="fields")
+    bm25_k1: Optional[float] = Field(default=None, alias="bm25_k1")
+    bm25_b: Optional[float] = Field(default=None, alias="bm25_b")
 
 
 class SearchByRandomRequest(SearchBase):

{vikingdb_python_sdk-0.1.10 → vikingdb_python_sdk-0.1.12}/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.10'
+__version__ = '0.1.12'

{vikingdb_python_sdk-0.1.10 → vikingdb_python_sdk-0.1.12/vikingdb_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vikingdb-python-sdk
-Version: 0.1.10
+Version: 0.1.12
 Summary: vikingdb Python SDK
 License: Apache-2.0
 Project-URL: Documentation, https://github.com/volcengine/volc-vikingdb-python-sdk/README.md

{vikingdb_python_sdk-0.1.10 → vikingdb_python_sdk-0.1.12}/vikingdb/vector/client.py

@@ -86,35 +86,6 @@ class VikingDB(Client):
         except Exception as exp:
             raise VikingConnectionException(f"failed to ping {host} ", str(exp))
 
-
-@_deprecated("VikingVector is deprecated; use VikingDB instead.")
-class VikingVector(VikingDB):
-    """Deprecated alias for VikingDB."""
-
-    def __init__(
-        self,
-        *,
-        host: str,
-        region: str,
-        auth: Auth,
-        scheme: str = "https",
-        sts_token: str = "",
-        timeout: int = 30,
-    ) -> None:
-        warnings.warn(
-            "VikingVector is deprecated; use VikingDB instead.",
-            FutureWarning,
-            stacklevel=2,
-        )
-        super().__init__(
-            host=host,
-            region=region,
-            auth=auth,
-            scheme=scheme,
-            sts_token=sts_token,
-            timeout=timeout,
-        )
-
     def collection(
         self,
         *,
@@ -331,3 +302,32 @@ class VikingVector(VikingDB):
                 header,
             ),
         }
+
+
+@_deprecated("VikingVector is deprecated; use VikingDB instead.")
+class VikingVector(VikingDB):
+    """Deprecated alias for VikingDB."""
+
+    def __init__(
+        self,
+        *,
+        host: str,
+        region: str,
+        auth: Auth,
+        scheme: str = "https",
+        sts_token: str = "",
+        timeout: int = 30,
+    ) -> None:
+        warnings.warn(
+            "VikingVector is deprecated; use VikingDB instead.",
+            FutureWarning,
+            stacklevel=2,
+        )
+        super().__init__(
+            host=host,
+            region=region,
+            auth=auth,
+            scheme=scheme,
+            sts_token=sts_token,
+            timeout=timeout,
+        )