vikingdb-python-sdk 0.1.15__tar.gz → 0.1.20__tar.gz

{vikingdb_python_sdk-0.1.15 → vikingdb_python_sdk-0.1.20}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: vikingdb-python-sdk
-Version: 0.1.15
+Version: 0.1.20
 Summary: vikingdb Python SDK
 License: Apache-2.0
-Project-URL: Documentation, https://github.com/volcengine/volc-vikingdb-python-sdk/README.md
-Project-URL: Source, https://github.com/volcengine/volc-vikingdb-python-sdk
+Project-URL: Documentation, https://github.com/volcengine/vikingdb-python-sdk/blob/main/README.md
+Project-URL: Source, https://github.com/volcengine/vikingdb-python-sdk
 Keywords: vikingdb,vector,bytedance,volcengine,sdk
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers

{vikingdb_python_sdk-0.1.15 → vikingdb_python_sdk-0.1.20}/pyproject.toml

@@ -31,8 +31,8 @@ dependencies = [
 ]
 
 [project.urls]
-Documentation = "https://github.com/volcengine/volc-vikingdb-python-sdk/README.md"
-Source = "https://github.com/volcengine/volc-vikingdb-python-sdk"
+Documentation = "https://github.com/volcengine/vikingdb-python-sdk/blob/main/README.md"
+Source = "https://github.com/volcengine/vikingdb-python-sdk"
 
 [tool.setuptools.packages.find]
 where = ["."]

{vikingdb_python_sdk-0.1.15 → vikingdb_python_sdk-0.1.20}/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.15 → vikingdb_python_sdk-0.1.20}/vikingdb/knowledge/models/doc.py

@@ -63,6 +63,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")
+    path_segments: Optional[List[str]] = Field(default=None, alias="path_segments")
 
 class DedupInfo(Model):
     skip: Optional[bool] = Field(default=None, alias="skip")

{vikingdb_python_sdk-0.1.15 → vikingdb_python_sdk-0.1.20}/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.15 → vikingdb_python_sdk-0.1.20}/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.15 → vikingdb_python_sdk-0.1.20}/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.15 → vikingdb_python_sdk-0.1.20}/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.15 → vikingdb_python_sdk-0.1.20}/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.15 → vikingdb_python_sdk-0.1.20}/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.15'
+__version__ = '0.1.20'

{vikingdb_python_sdk-0.1.15 → vikingdb_python_sdk-0.1.20}/vikingdb_python_sdk.egg-info/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: vikingdb-python-sdk
-Version: 0.1.15
+Version: 0.1.20
 Summary: vikingdb Python SDK
 License: Apache-2.0
-Project-URL: Documentation, https://github.com/volcengine/volc-vikingdb-python-sdk/README.md
-Project-URL: Source, https://github.com/volcengine/volc-vikingdb-python-sdk
+Project-URL: Documentation, https://github.com/volcengine/vikingdb-python-sdk/blob/main/README.md
+Project-URL: Source, https://github.com/volcengine/vikingdb-python-sdk
 Keywords: vikingdb,vector,bytedance,volcengine,sdk
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers