vikingdb-python-sdk 0.1.14__tar.gz → 0.1.18__tar.gz

{vikingdb_python_sdk-0.1.14 → vikingdb_python_sdk-0.1.18}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.1
 Name: vikingdb-python-sdk
-Version: 0.1.14
+Version: 0.1.18
 Summary: vikingdb Python SDK
 License: Apache-2.0
 Project-URL: Documentation, https://github.com/volcengine/volc-vikingdb-python-sdk/README.md
@@ -24,7 +24,6 @@ Requires-Dist: typing_extensions>=4.9.0
 Requires-Dist: urllib3>=1.21.1
 Requires-Dist: volcengine>=1.0.0
 Requires-Dist: aiohttp>=3.10.0
-Dynamic: license-file
 
 ## VikingDB Python SDK (v2)
 

{vikingdb_python_sdk-0.1.14 → vikingdb_python_sdk-0.1.18}/vikingdb/_client.py

@@ -54,9 +54,9 @@ class Client(Service, ABC):
         )
         self.api_info = self._build_api_info()
         # 判断auth是不是IAM 还是 APIKey类型
-        if isinstance(auth, IAM):
-            super().__init__(self.service_info, self.api_info)
-        elif isinstance(auth, (APIKey, HeaderAuth)):
+        if isinstance(auth, (IAM, APIKey, HeaderAuth)):
+            # volcengine Service.init() 可能读取环境变量或 ~/.volc/config 覆盖 AK/SK，
+            # 这里确保使用用户传入的 IAM 凭证，因此不使用super().__init__初始化
             self.session = requests.session()
         else:
             raise ValueError("auth must be IAM, APIKey or HeaderAuth type")

{vikingdb_python_sdk-0.1.14 → vikingdb_python_sdk-0.1.18}/vikingdb/knowledge/collection.py

@@ -8,7 +8,7 @@ import json
 from typing import Mapping, Optional, Union, List
 import warnings
 
-from .models.base import CollectionMeta, Model
+from .models.base import CollectionMeta, CommonResponse, Model
 from .models.doc import DocInfo, ListDocsResponse, AddDocRequest, ListDocsRequest, MetaItem, AddDocV2Request, AddDocResponse
 from .models.point import (
     ListPointsResponse,
@@ -74,10 +74,11 @@ class KnowledgeCollection:
         *,
         headers: Optional[Mapping[str, str]] = None,
         timeout: Optional[int] = None,
-    ):
+    ) -> CommonResponse:
         payload = {**self._meta_payload, "doc_id": doc_id}
         res = self.client.json_exception("DeleteDoc", {}, json.dumps(payload), headers=headers, timeout=timeout)
-        return res
+        response = CommonResponse.model_validate(res)
+        return response
 
     def get_doc(
         self,
@@ -123,10 +124,11 @@ class KnowledgeCollection:
         *,
         headers: Optional[Mapping[str, str]] = None,
         timeout: Optional[int] = None,
-    ):
+    ) -> CommonResponse:
         payload = {**self._meta_payload, "doc_id": doc_id, "meta": [item.model_dump(by_alias=True) for item in meta]}
         res = self.client.json_exception("UpdateDocMeta", {}, json.dumps(payload), headers=headers, timeout=timeout)
-        return res
+        response = CommonResponse.model_validate(res)
+        return response
 
     def update_doc(
         self,
@@ -135,10 +137,11 @@ class KnowledgeCollection:
         *,
         headers: Optional[Mapping[str, str]] = None,
         timeout: Optional[int] = None,
-    ):
+    ) -> CommonResponse:
         payload = {**self._meta_payload, "doc_id": doc_id, "doc_name": doc_name}
         res = self.client.json_exception("UpdateDoc", {}, json.dumps(payload), headers=headers, timeout=timeout)
-        return res
+        response = CommonResponse.model_validate(res)
+        return response
 
     def get_point(
         self,
@@ -183,7 +186,7 @@ class KnowledgeCollection:
         *,
         headers: Optional[Mapping[str, str]] = None,
         timeout: Optional[int] = None,
-    ):
+    ) -> PointAddResponse:
         req_payload = (
             request.model_dump(by_alias=True, exclude_none=True)  # type: ignore[attr-defined]
             if isinstance(request, Model)
@@ -201,7 +204,7 @@ class KnowledgeCollection:
         *,
         headers: Optional[Mapping[str, str]] = None,
         timeout: Optional[int] = None,
-    ):
+    ) -> CommonResponse:
         upd_payload = (
             update.model_dump(by_alias=True, exclude_none=True)  # type: ignore[attr-defined]
             if isinstance(update, Model)
@@ -209,7 +212,8 @@ class KnowledgeCollection:
         )
         payload = {**self._meta_payload, "point_id": point_id, **upd_payload}
         res = self.client.json_exception("UpdatePoint", {}, json.dumps(payload), headers=headers, timeout=timeout)
-        return res
+        response = CommonResponse.model_validate(res)
+        return response
 
     def delete_point(
         self,
@@ -217,7 +221,7 @@ class KnowledgeCollection:
         *,
         headers: Optional[Mapping[str, str]] = None,
         timeout: Optional[int] = None,
-    ):
+    ) -> CommonResponse:
         req_payload = (
             request.model_dump(by_alias=True, exclude_none=True)  # type: ignore[attr-defined]
             if isinstance(request, Model)
@@ -225,7 +229,8 @@ class KnowledgeCollection:
         )
         payload = {**self._meta_payload, **req_payload}
         res = self.client.json_exception("DeletePoint", {}, json.dumps(payload), headers=headers, timeout=timeout)
-        return res
+        response = CommonResponse.model_validate(res)
+        return response
 
     def search_collection(
         self,

{vikingdb_python_sdk-0.1.14 → vikingdb_python_sdk-0.1.18}/vikingdb/knowledge/models/base.py

@@ -29,10 +29,10 @@ class CollectionMeta(Model):
 
 
 class CommonResponse(Model):
-    api: Optional[str] = Field(default=None, alias="api")
+    code: Optional[int] = Field(default=None, alias="code")
     message: Optional[str] = Field(default=None, alias="message")
-    code: Optional[str] = Field(default=None, alias="code")
     request_id: Optional[str] = Field(default=None, alias="request_id")
+    data: Optional[Any] = Field(default=None, alias="data")
 
 
 class DataApiResponse(Model):

{vikingdb_python_sdk-0.1.14 → vikingdb_python_sdk-0.1.18}/vikingdb/knowledge/models/point.py

@@ -54,8 +54,8 @@ class UpdatePointRequest(Model):
 class ListPointsRequest(Model):
     offset: int = Field(default=0, alias="offset")
     limit: int = Field(default=-1, alias="limit")
-    doc_ids: Optional[Dict[str, Any]] = Field(default=None, alias="doc_ids")
-    point_ids: Optional[Dict[str, Any]] = Field(default=None, alias="point_ids")
+    doc_ids: Optional[List[str]] = Field(default=None, alias="doc_ids")
+    point_ids: Optional[List[str]] = Field(default=None, alias="point_ids")
     get_attachment_link: Optional[bool] = Field(default=False, alias="get_attachment_link")
 
 class DeletePointRequest(Model):

{vikingdb_python_sdk-0.1.14 → vikingdb_python_sdk-0.1.18}/vikingdb/knowledge/models/rerank.py

@@ -18,7 +18,7 @@ __all__ = [
 
 class RerankDataItem(Model):
     query: object = Field(alias="query")
-    content: str = Field(alias="content")
+    content: str = Field(default=None, alias="content")
     title: Optional[str] = Field(default=None, alias="title")
     image: Union[str, List[str]] = Field(default=None, alias="image")
 

{vikingdb_python_sdk-0.1.14 → vikingdb_python_sdk-0.1.18}/vikingdb/knowledge/models/search.py

@@ -21,7 +21,7 @@ __all__ = [
 ]
 
 class SearchCollectionRequest(Model):
-    query: Any = Field(alias="query")
+    query: str = Field(alias="query")
     limit: int = Field(default=10, alias="limit")
     dense_weight: float = Field(default=0.5, alias="dense_weight")
     rerank_switch: bool = Field(default=False, alias="rerank_switch")
@@ -40,8 +40,8 @@ class SearchResponse(DataApiResponse):
 
 
 class SearchKnowledgeRequest(Model):
-    query: Any = Field(alias="query")
-    image_query: Optional[Any] = Field(default=None, alias="image_query")
+    query: str = Field(alias="query")
+    image_query: Optional[str] = Field(default=None, alias="image_query")
     pre_processing: Optional[Dict[str, Any]] = Field(default=None, alias="pre_processing")
     post_processing: Optional[Dict[str, Any]] = Field(default=None, alias="post_processing")
     query_param: Optional[Dict[str, Any]] = Field(default=None, alias="query_param")

{vikingdb_python_sdk-0.1.14 → vikingdb_python_sdk-0.1.18}/vikingdb/vector/models/__init__.py

@@ -26,6 +26,7 @@ from .collection import (
 from .embedding import (
     Embedding,
     EmbeddingData,
+    EmbeddingInstruction,
     EmbeddingModelOpt,
     EmbeddingRequest,
     EmbeddingResponse,
@@ -46,6 +47,8 @@ from .index import (
     FetchDataInIndexResponse,
     FetchDataInIndexResult,
     IndexDataItem,
+    Instruction,
+    ModelRerank,
     SearchAdvance,
     SearchByIDRequest,
     SearchByKeywordsRequest,
@@ -56,6 +59,7 @@ from .index import (
     SearchItemResult,
     SearchResponse,
     SearchResult,
+    TensorRerank,
 )
 
 __all__ = [
@@ -69,6 +73,7 @@ __all__ = [
     "DeleteDataResponse",
     "Embedding",
     "EmbeddingData",
+    "EmbeddingInstruction",
     "EmbeddingModelOpt",
     "EmbeddingRequest",
     "EmbeddingResponse",
@@ -86,6 +91,8 @@ __all__ = [
     "FullModalData",
     "IndexDataItem",
     "IndexMeta",
+    "Instruction",
+    "ModelRerank",
     "PaginationResponse",
     "SearchAdvance",
     "SearchByIDRequest",
@@ -97,6 +104,7 @@ __all__ = [
     "SearchItemResult",
     "SearchResponse",
     "SearchResult",
+    "TensorRerank",
     "UpsertDataRequest",
     "UpsertDataResponse",
     "UpsertDataResult",

{vikingdb_python_sdk-0.1.14 → vikingdb_python_sdk-0.1.18}/vikingdb/vector/models/collection.py

@@ -40,6 +40,7 @@ class UpdateDataResult(Model):
 class DeleteDataRequest(Model):
     ids: Optional[Sequence[Any]] = Field(default=None, alias="ids")
     delete_all: Optional[bool] = Field(default=None, alias="del_all")
+    async_write: Optional[bool] = Field(default=None, alias="async")
 
 
 class DeleteDataResponse(DataApiResponse):
@@ -48,6 +49,8 @@ class DeleteDataResponse(DataApiResponse):
 
 class FetchDataInCollectionRequest(Model):
     ids: Sequence[Any] = Field(alias="ids")
+    return_download_url: Optional[bool] = Field(default=None, alias="return_download_url")
+    return_analyzed_result: Optional[bool] = Field(default=None, alias="return_analyzed_result")
 
 
 class FetchDataInCollectionResult(Model):

{vikingdb_python_sdk-0.1.14 → vikingdb_python_sdk-0.1.18}/vikingdb/vector/models/embedding.py

@@ -10,10 +10,17 @@ from pydantic import Field
 from .base import DataApiResponse, Model
 
 
+class EmbeddingInstruction(Model):
+    content: Optional[str] = Field(default=None, alias="content")
+
+
 class EmbeddingModelOpt(Model):
     name: Optional[str] = Field(default=None, alias="name")
     version: Optional[str] = Field(default=None, alias="version")
     dim: Optional[int] = Field(default=None, alias="dim")
+    ndim: Optional[int] = Field(default=None, alias="ndim")
+    shape: Optional[Sequence[int]] = Field(default=None, alias="shape")
+    instruction: Optional[EmbeddingInstruction] = Field(default=None, alias="instruction")
 
 
 class FullModalData(Model):
@@ -33,7 +40,9 @@ class EmbeddingRequest(Model):
     data: Sequence[EmbeddingData] = Field(alias="data")
     dense_model: Optional[EmbeddingModelOpt] = Field(default=None, alias="dense_model")
     sparse_model: Optional[EmbeddingModelOpt] = Field(default=None, alias="sparse_model")
+    tensor_model: Optional[EmbeddingModelOpt] = Field(default=None, alias="tensor_model")
     project_name: Optional[str] = Field(default=None, alias="project_name")
+    max_retry_time: Optional[int] = Field(default=None, alias="max_retry_time")
 
 
 class Embedding(Model):

{vikingdb_python_sdk-0.1.14 → vikingdb_python_sdk-0.1.18}/vikingdb/vector/models/index.py

@@ -53,6 +53,30 @@ class SearchBase(RecallBase):
     limit: Optional[int] = Field(default=None, alias="limit")
     offset: Optional[int] = Field(default=None, alias="offset")
     advance: Optional[SearchAdvance] = Field(default=None, alias="advance")
+    return_schema: Optional[bool] = Field(default=None, alias="return_schema")
+    return_download_url: Optional[bool] = Field(default=None, alias="return_download_url")
+    return_analyzed_result: Optional[bool] = Field(default=None, alias="return_analyzed_result")
+    return_detail_info: Optional[bool] = Field(default=None, alias="return_detail_info")
+
+
+class Instruction(Model):
+    auto_fill: Optional[bool] = Field(default=None, alias="auto_fill")
+
+
+class TensorRerank(Model):
+    tensor: Optional[Sequence[Sequence[float]]] = Field(default=None, alias="tensor")
+    input_limit: Optional[int] = Field(default=None, alias="input_limit")
+    max_similarity_algo: Optional[str] = Field(default=None, alias="max_similarity_algo")
+
+
+class ModelRerank(Model):
+    model_name: Optional[str] = Field(default=None, alias="model_name")
+    model_version: Optional[str] = Field(default=None, alias="model_version")
+    instruction: Optional[str] = Field(default=None, alias="instruction")
+    input_limit: Optional[int] = Field(default=None, alias="input_limit")
+    score_threshold: Optional[float] = Field(default=None, alias="score_threshold")
+    fail_strategy: Optional[str] = Field(default=None, alias="fail_strategy")
+    timeout_ms: Optional[int] = Field(default=None, alias="timeout_ms")
 
 
 class SearchItemResult(Model):
@@ -60,6 +84,8 @@ class SearchItemResult(Model):
     fields: Dict[str, Any] = Field(default_factory=dict, alias="fields")
     ann_score: Optional[float] = Field(default=None, alias="ann_score")
     score: Optional[float] = Field(default=None, alias="score")
+    origin_score: Optional[float] = Field(default=None, alias="origin_score")
+    addition_score: Optional[float] = Field(default=None, alias="addition_score")
 
 
 class SearchResult(Model):
@@ -68,6 +94,14 @@ class SearchResult(Model):
     total_return_count: Optional[int] = Field(default=None, alias="total_return_count")
     real_text_query: Optional[str] = Field(default=None, alias="real_text_query")
     token_usage: Dict[str, Any] = Field(default_factory=dict, alias="token_usage")
+    schema: Optional[Mapping[str, Any]] = Field(default=None, alias="schema")
+    rerank_error: Optional[str] = Field(default=None, alias="rerank_error")
+    instruction_for_dense: Optional[str] = Field(default=None, alias="instruction_for_dense")
+    instruction_for_sparse: Optional[str] = Field(default=None, alias="instruction_for_sparse")
+    instruction_for_tensor: Optional[str] = Field(default=None, alias="instruction_for_tensor")
+    embedding_time_cost_ms: Optional[int] = Field(default=None, alias="embedding_time_cost_ms")
+    recall_time_cost_ms: Optional[int] = Field(default=None, alias="recall_time_cost_ms")
+    rerank_time_cost_ms: Optional[int] = Field(default=None, alias="rerank_time_cost_ms")
 
 
 class SearchResponse(DataApiResponse):
@@ -77,6 +111,7 @@ class SearchResponse(DataApiResponse):
 class SearchByVectorRequest(SearchBase):
     dense_vector: Sequence[float] = Field(alias="dense_vector")
     sparse_vector: Optional[Mapping[str, float]] = Field(default=None, alias="sparse_vector")
+    tensor_rerank: Optional[TensorRerank] = Field(default=None, alias="tensor_rerank")
 
 
 class SearchByMultiModalRequest(SearchBase):
@@ -84,6 +119,9 @@ class SearchByMultiModalRequest(SearchBase):
     image: Optional[Any] = Field(default=None, alias="image")
     video: Optional[Any] = Field(default=None, alias="video")
     need_instruction: Optional[bool] = Field(default=None, alias="need_instruction")
+    instruction: Optional[Instruction] = Field(default=None, alias="instruction")
+    tensor_rerank: Optional[TensorRerank] = Field(default=None, alias="tensor_rerank")
+    rerank: Optional[ModelRerank] = Field(default=None, alias="rerank")
 
 
 class SearchByIDRequest(SearchBase):
@@ -124,4 +162,3 @@ class AggResult(Model):
 
 class AggResponse(DataApiResponse):
     result: Optional[AggResult] = None
-

{vikingdb_python_sdk-0.1.14 → vikingdb_python_sdk-0.1.18}/vikingdb/vector/models/rerank.py

@@ -12,12 +12,14 @@ from .embedding import FullModalData
 
 
 class RerankRequest(Model):
+    project_name: Optional[str] = Field(default=None, alias="project_name")
     model_name: Optional[str] = Field(alias="model_name")
     model_version: Optional[str] = Field(default=None, alias="model_version")
     data: Sequence[Sequence[FullModalData]] = Field(alias="data")
     query: Sequence[FullModalData] = Field(alias="query")
     instruction: Optional[str] = Field(default=None, alias="instruction")
     return_origin_data: Optional[bool] = Field(default=None, alias="return_origin_data")
+    max_retry_time: Optional[int] = Field(default=None, alias="max_retry_time")
 
 
 class RerankResult(Model):

{vikingdb_python_sdk-0.1.14 → vikingdb_python_sdk-0.1.18}/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.14'
+__version__ = '0.1.18'

{vikingdb_python_sdk-0.1.14 → vikingdb_python_sdk-0.1.18}/vikingdb_python_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.1
 Name: vikingdb-python-sdk
-Version: 0.1.14
+Version: 0.1.18
 Summary: vikingdb Python SDK
 License: Apache-2.0
 Project-URL: Documentation, https://github.com/volcengine/volc-vikingdb-python-sdk/README.md
@@ -24,7 +24,6 @@ Requires-Dist: typing_extensions>=4.9.0
 Requires-Dist: urllib3>=1.21.1
 Requires-Dist: volcengine>=1.0.0
 Requires-Dist: aiohttp>=3.10.0
-Dynamic: license-file
 
 ## VikingDB Python SDK (v2)