vikingdb-python-sdk 0.1.4__tar.gz

vikingdb_python_sdk-0.1.4/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

vikingdb_python_sdk-0.1.4/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: vikingdb-python-sdk
+Version: 0.1.4
+Summary: vikingdb Python SDK
+License-Expression: 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
+Keywords: vikingdb,vector,bytedance,volcengine,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: numpy>=1.21.6
+Requires-Dist: httpx>=0.24.1
+Requires-Dist: requests>=2.28.1
+Requires-Dist: pydantic>=2.5.3
+Requires-Dist: urllib3>=2.0.7
+Requires-Dist: volcengine>=1.0.0
+Requires-Dist: aiohttp>=3.10.0
+Dynamic: license-file
+
+## VikingDB Python SDK (v2)
+
+This package provides an idiomatic Python interface to the VikingDB v2 data-plane APIs. The SDK mirrors the behaviour and API surface of the official Java and Go clients while embracing Python conventions (dataclasses/pydantic models, requests-based transport, and pytest-driven examples).
+
+### Key Features
+- Simple client configuration with AK/SK signing (Volcano Engine V4) or API-key authentication.
+- **Vector Database**: Request envelope handling with typed request/response models covering collection, index, and embedding workflows.
+- **Memory Management**: Conversational memory APIs for managing user profiles, events, and session messages with semantic search capabilities.
+- Pluggable retry strategy (exponential backoff with jitter) and per-request overrides (`RequestOptions`).
+- Executable example guides (`pytest` integration tests and standalone scripts) that demonstrate connectivity, CRUD, search, analytics, embedding, and memory management scenarios against a real VikingDB environment.
+
+### Installation
+
+Clone the repository and install the SDK in editable mode:
+
+```bash
+uv add vikingdb-python-sdk
+```
+
+> **Dependencies:** The SDK relies on `requests`, `pydantic>=2.5`, and the Volcano Engine base SDK (`volcengine`) for request signing.
+
+### Quickstart
+
+#### Vector Database
+
+```python
+import os
+from vikingdb import IAM
+from vikingdb.vector import SearchByRandomRequest, VikingVector
+
+auth = IAM(ak=os.environ["VIKINGDB_AK"], sk=os.environ["VIKINGDB_SK"]) 
+client = VikingVector(
+    host=os.environ["VIKINGDB_HOST"],
+    region=os.environ["VIKINGDB_REGION"],
+    auth=auth,
+    scheme="https",
+    timeout=30,
+)
+index = client.index(
+    collection_name=os.environ["VIKINGDB_COLLECTION"],
+    index_name=os.environ["VIKINGDB_INDEX"],
+)
+resp = index.search_by_random(SearchByRandomRequest(limit=1))
+print(f"request_id={resp.request_id} hits={len(resp.result.data or [])}")
+```
+
+#### Memory Management
+
+```python
+from vikingdb import IAM
+from vikingdb.memory import VikingMem
+
+auth = IAM(ak="<AK>", sk="<SK>")
+client = VikingMem(
+    host="api-knowledgebase.mlp.cn-beijing.volces.com",
+    region="cn-beijing",
+    auth=auth,
+    scheme="http",
+)
+
+# Get collection
+collection = client.get_collection(
+    collection_name="demo_collection",
+    project_name="default"
+)
+
+# Add session messages
+collection.add_session(
+    session_id="session_001",
+    messages=[
+        {"role": "user", "content": "Hello, how is the weather today?"},
+        {"role": "assistant", "content": "Today is sunny, perfect for going out."}
+    ],
+    metadata={
+        "default_user_id": "user_001",
+        "default_assistant_id": "assistant_001",
+    }
+)
+
+# Search memories
+result = collection.search_memory(
+    query="weather today",
+    filter={"user_id": "user_001", "memory_type": ["event_v1"]},
+    limit=10
+)
+print("search results:", result)
+```
+
+### Example Guides
+
+#### Vector Examples
+
+The integration guides under `examples/vector` mirror the Go SDK walkthroughs (`1`–`6`). Each test connects to a live VikingDB environment and exercises a specific workflow.
+
+1. Set the required environment variables (or create a `.env` file in the project root):
+
+   ```
+   VIKINGDB_AK=your-access-key
+   VIKINGDB_SK=your-secret-key
+   VIKINGDB_COLLECTION=demo_collection
+   VIKINGDB_INDEX=demo_index
+   # Optional:
+   # VIKINGDB_PROJECT=project-name
+   # VIKINGDB_RESOURCE_ID=resource-id
+   ```
+
+   The pytest guides themselves lock to the ap-southeast-1 public datasets:
+
+   - host: `api-vikingdb.vikingdb.ap-southeast-1.volces.com`
+   - region: `ap-southeast-1`
+   - text walkthroughs use `collection=text`, `index=text_index`
+   - vector walkthroughs use `collection=vector`, `index=vector_index`
+
+2. Install pytest (if not already available):
+
+   ```bash
+   uv add --dev pytest
+   ```
+
+3. Execute the guides:
+
+   ```bash
+   uv run pytest examples/vector -k scenario
+   ```
+
+Each scenario writes temporary documents using unique session tags and cleans them up afterwards.
+
+#### Memory Examples
+
+The memory examples under `examples/memory` demonstrate the core workflows for managing conversational memories:
+
+1. **01_init_client_and_collection.py**: Initialize the VikingMem client and get collection instances using either collection name + project name or resource ID.
+
+2. **02_add_session.py**: Add session messages (user-assistant conversations) to the memory collection with metadata such as user ID, assistant ID, and timestamps.
+
+3. **03_search_memory.py**: Search memories with various filters including:
+   - User profile search
+   - Event search by semantic query
+   - Time range filtering for recent events
+
+To run the memory examples:
+
+```bash
+# Set environment variables
+export VIKINGDB_AK=your-access-key
+export VIKINGDB_SK=your-secret-key
+
+# Run individual examples
+python examples/memory/01_init_client_and_collection.py
+python examples/memory/02_add_session.py
+python examples/memory/03_search_memory.py
+```
+
+### Architecture Overview
+
+- `vikingdb._client`, `vikingdb.auth`, `vikingdb.request_options`, and `vikingdb.vector.exceptions` form the shared runtime used by all present and future SDK domains (vector, memory, knowledge).
+- Domain-specific features live under dedicated namespaces such as `vikingdb.vector` and `vikingdb.memory`, where the high-level clients (`VikingVector`, `VikingMem`) compose the shared auth stack atop the shared client.
+- Vector request/response models now surface directly from `vikingdb.vector` (backed internally by `vikingdb/vector/models`).
+- Memory APIs return plain dictionaries without object encapsulation, providing a lightweight interface for conversational memory management (session, profile, event operations).
+- Imports from the root package now focus on cross-cutting utilities (auth, config, request options), while application code should pull domain-specific functionality from `vikingdb.vector` or `vikingdb.memory` explicitly.
+
+### Project Structure
+
+```
+vikingdb/
+├── _client.py          # Shared base client built on volcengine Service
+├── auth.py              # Shared auth providers (IAM, API key)
+├── request_options.py   # Per-request overrides shared by all services
+├── version.py           # Package metadata
+├── vector/              # Vector-specific clients and models
+│   ├── __init__.py      # High-level vector client and namespace exports
+│   ├── base.py          # Shared helpers for vector clients
+│   ├── collection.py    # Collection operations
+│   ├── embedding.py     # Embedding operations
+│   ├── index.py         # Index/search operations
+│   ├── client.py        # Vector service wrapper and high-level client
+│   ├── exceptions.py    # Vector-specific exceptions
+│   └── models/          # Vector request/response models (pydantic)
+├── memory/              # Memory-specific clients and models
+│   ├── __init__.py      # High-level memory client and namespace exports
+│   ├── client.py        # VikingMem service client
+│   ├── collection.py    # Memory collection operations
+│   ├── types.py         # Type definitions for memory operations
+│   └── exceptions.py    # Memory-specific exceptions
+
+examples/
+├── vector/              # Vector integration guides (pytest)
+│   ├── 1_connectivity_test.py
+│   ├── 2_collection_lifecycle_test.py
+│   ├── 3_*_test.py     # Search and indexing examples
+│   └── ...
+└── memory/              # Memory usage examples
+    ├── 01_init_client_and_collection.py
+    ├── 02_add_session.py
+    └── 03_search_memory.py
+```
+
+### Contributing
+
+Contributions and feedback are welcome. Please ensure any new APIs match the OpenAPI specification and include accompanying example coverage.

vikingdb_python_sdk-0.1.4/README.md

@@ -0,0 +1,200 @@
+## VikingDB Python SDK (v2)
+
+This package provides an idiomatic Python interface to the VikingDB v2 data-plane APIs. The SDK mirrors the behaviour and API surface of the official Java and Go clients while embracing Python conventions (dataclasses/pydantic models, requests-based transport, and pytest-driven examples).
+
+### Key Features
+- Simple client configuration with AK/SK signing (Volcano Engine V4) or API-key authentication.
+- **Vector Database**: Request envelope handling with typed request/response models covering collection, index, and embedding workflows.
+- **Memory Management**: Conversational memory APIs for managing user profiles, events, and session messages with semantic search capabilities.
+- Pluggable retry strategy (exponential backoff with jitter) and per-request overrides (`RequestOptions`).
+- Executable example guides (`pytest` integration tests and standalone scripts) that demonstrate connectivity, CRUD, search, analytics, embedding, and memory management scenarios against a real VikingDB environment.
+
+### Installation
+
+Clone the repository and install the SDK in editable mode:
+
+```bash
+uv add vikingdb-python-sdk
+```
+
+> **Dependencies:** The SDK relies on `requests`, `pydantic>=2.5`, and the Volcano Engine base SDK (`volcengine`) for request signing.
+
+### Quickstart
+
+#### Vector Database
+
+```python
+import os
+from vikingdb import IAM
+from vikingdb.vector import SearchByRandomRequest, VikingVector
+
+auth = IAM(ak=os.environ["VIKINGDB_AK"], sk=os.environ["VIKINGDB_SK"]) 
+client = VikingVector(
+    host=os.environ["VIKINGDB_HOST"],
+    region=os.environ["VIKINGDB_REGION"],
+    auth=auth,
+    scheme="https",
+    timeout=30,
+)
+index = client.index(
+    collection_name=os.environ["VIKINGDB_COLLECTION"],
+    index_name=os.environ["VIKINGDB_INDEX"],
+)
+resp = index.search_by_random(SearchByRandomRequest(limit=1))
+print(f"request_id={resp.request_id} hits={len(resp.result.data or [])}")
+```
+
+#### Memory Management
+
+```python
+from vikingdb import IAM
+from vikingdb.memory import VikingMem
+
+auth = IAM(ak="<AK>", sk="<SK>")
+client = VikingMem(
+    host="api-knowledgebase.mlp.cn-beijing.volces.com",
+    region="cn-beijing",
+    auth=auth,
+    scheme="http",
+)
+
+# Get collection
+collection = client.get_collection(
+    collection_name="demo_collection",
+    project_name="default"
+)
+
+# Add session messages
+collection.add_session(
+    session_id="session_001",
+    messages=[
+        {"role": "user", "content": "Hello, how is the weather today?"},
+        {"role": "assistant", "content": "Today is sunny, perfect for going out."}
+    ],
+    metadata={
+        "default_user_id": "user_001",
+        "default_assistant_id": "assistant_001",
+    }
+)
+
+# Search memories
+result = collection.search_memory(
+    query="weather today",
+    filter={"user_id": "user_001", "memory_type": ["event_v1"]},
+    limit=10
+)
+print("search results:", result)
+```
+
+### Example Guides
+
+#### Vector Examples
+
+The integration guides under `examples/vector` mirror the Go SDK walkthroughs (`1`–`6`). Each test connects to a live VikingDB environment and exercises a specific workflow.
+
+1. Set the required environment variables (or create a `.env` file in the project root):
+
+   ```
+   VIKINGDB_AK=your-access-key
+   VIKINGDB_SK=your-secret-key
+   VIKINGDB_COLLECTION=demo_collection
+   VIKINGDB_INDEX=demo_index
+   # Optional:
+   # VIKINGDB_PROJECT=project-name
+   # VIKINGDB_RESOURCE_ID=resource-id
+   ```
+
+   The pytest guides themselves lock to the ap-southeast-1 public datasets:
+
+   - host: `api-vikingdb.vikingdb.ap-southeast-1.volces.com`
+   - region: `ap-southeast-1`
+   - text walkthroughs use `collection=text`, `index=text_index`
+   - vector walkthroughs use `collection=vector`, `index=vector_index`
+
+2. Install pytest (if not already available):
+
+   ```bash
+   uv add --dev pytest
+   ```
+
+3. Execute the guides:
+
+   ```bash
+   uv run pytest examples/vector -k scenario
+   ```
+
+Each scenario writes temporary documents using unique session tags and cleans them up afterwards.
+
+#### Memory Examples
+
+The memory examples under `examples/memory` demonstrate the core workflows for managing conversational memories:
+
+1. **01_init_client_and_collection.py**: Initialize the VikingMem client and get collection instances using either collection name + project name or resource ID.
+
+2. **02_add_session.py**: Add session messages (user-assistant conversations) to the memory collection with metadata such as user ID, assistant ID, and timestamps.
+
+3. **03_search_memory.py**: Search memories with various filters including:
+   - User profile search
+   - Event search by semantic query
+   - Time range filtering for recent events
+
+To run the memory examples:
+
+```bash
+# Set environment variables
+export VIKINGDB_AK=your-access-key
+export VIKINGDB_SK=your-secret-key
+
+# Run individual examples
+python examples/memory/01_init_client_and_collection.py
+python examples/memory/02_add_session.py
+python examples/memory/03_search_memory.py
+```
+
+### Architecture Overview
+
+- `vikingdb._client`, `vikingdb.auth`, `vikingdb.request_options`, and `vikingdb.vector.exceptions` form the shared runtime used by all present and future SDK domains (vector, memory, knowledge).
+- Domain-specific features live under dedicated namespaces such as `vikingdb.vector` and `vikingdb.memory`, where the high-level clients (`VikingVector`, `VikingMem`) compose the shared auth stack atop the shared client.
+- Vector request/response models now surface directly from `vikingdb.vector` (backed internally by `vikingdb/vector/models`).
+- Memory APIs return plain dictionaries without object encapsulation, providing a lightweight interface for conversational memory management (session, profile, event operations).
+- Imports from the root package now focus on cross-cutting utilities (auth, config, request options), while application code should pull domain-specific functionality from `vikingdb.vector` or `vikingdb.memory` explicitly.
+
+### Project Structure
+
+```
+vikingdb/
+├── _client.py          # Shared base client built on volcengine Service
+├── auth.py              # Shared auth providers (IAM, API key)
+├── request_options.py   # Per-request overrides shared by all services
+├── version.py           # Package metadata
+├── vector/              # Vector-specific clients and models
+│   ├── __init__.py      # High-level vector client and namespace exports
+│   ├── base.py          # Shared helpers for vector clients
+│   ├── collection.py    # Collection operations
+│   ├── embedding.py     # Embedding operations
+│   ├── index.py         # Index/search operations
+│   ├── client.py        # Vector service wrapper and high-level client
+│   ├── exceptions.py    # Vector-specific exceptions
+│   └── models/          # Vector request/response models (pydantic)
+├── memory/              # Memory-specific clients and models
+│   ├── __init__.py      # High-level memory client and namespace exports
+│   ├── client.py        # VikingMem service client
+│   ├── collection.py    # Memory collection operations
+│   ├── types.py         # Type definitions for memory operations
+│   └── exceptions.py    # Memory-specific exceptions
+
+examples/
+├── vector/              # Vector integration guides (pytest)
+│   ├── 1_connectivity_test.py
+│   ├── 2_collection_lifecycle_test.py
+│   ├── 3_*_test.py     # Search and indexing examples
+│   └── ...
+└── memory/              # Memory usage examples
+    ├── 01_init_client_and_collection.py
+    ├── 02_add_session.py
+    └── 03_search_memory.py
+```
+
+### Contributing
+
+Contributions and feedback are welcome. Please ensure any new APIs match the OpenAPI specification and include accompanying example coverage.

vikingdb_python_sdk-0.1.4/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vikingdb-python-sdk"
+dynamic = ["version"]
+description = "vikingdb Python SDK"
+readme = "README.md"
+requires-python = ">=3.8"
+license = "Apache-2.0"
+keywords = ["vikingdb", "vector", "bytedance", "volcengine", "sdk"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Software Development :: Libraries",
+]
+dependencies = [
+    "numpy>=1.21.6",
+    "httpx>=0.24.1",
+    "requests>=2.28.1",
+    "pydantic>=2.5.3",
+    "urllib3>=2.0.7",
+    "volcengine>=1.0.0",
+    "aiohttp>=3.10.0",
+]
+
+[project.urls]
+Documentation = "https://github.com/volcengine/volc-vikingdb-python-sdk/README.md"
+Source = "https://github.com/volcengine/volc-vikingdb-python-sdk"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["vikingdb*"]
+
+[tool.setuptools.dynamic]
+version = {attr = "vikingdb.version.__version__"}
+
+[dependency-groups]
+dev = [
+    "pytest>=7.4.4",
+    "ruff>=0.14.3",
+]

vikingdb_python_sdk-0.1.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+