A unified Python client for seekdb that supports embedded, server, and OceanBase.
Project description
pyseekdb
pyseekdb is a Python SDK for seekdb and OceanBase AI search. It supports embedded and server deployments with vector, full-text, and hybrid retrieval, and exposes a collection-first API for application workflows. For advanced database operations, you can use MySQL-compatible drivers to run SQL against seekdb and OceanBase.
Key features:
- Unified API: Single interface for embedded and remote server modes
- Vector Operations: Efficient vector similarity search
- Hybrid Search: Combine vector and full-text search
- Embedding Functions: Built-in support for various embedding models
- Collection Management: Easy collection (table) creation and management
- Database Management: Admin operations for database management
Documentation
- Docs home: https://oceanbase.github.io/pyseekdb/
- User guide: https://oceanbase.github.io/pyseekdb/guide/
- API reference: https://oceanbase.github.io/pyseekdb/api/
- RAG demo: English / 中文
- Contributing: CONTRIBUTING.md
Installation
pip install -U pyseekdb
# or with uv
uv add pyseekdb
Quick Start
import pyseekdb
client = pyseekdb.Client(path="./seekdb.db", database="demo")
collection = client.get_or_create_collection("my_collection")
collection.add(
ids=["doc1", "doc2"],
documents=["Hello world", "pyseekdb quick start"],
metadatas=[{"tag": "hello"}, {"tag": "demo"}],
)
results = collection.query(query_texts=["hello"], n_results=3)
print(results["ids"][0])
For full usage, connection modes, collection management, and operations, see the User Guide: https://oceanbase.github.io/pyseekdb/guide/.
License
This package is licensed under Apache 2.0. See LICENSE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyseekdb-1.2.0.post1-py3-none-any.whl.
File metadata
- Download URL: pyseekdb-1.2.0.post1-py3-none-any.whl
- Upload date:
- Size: 124.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
592529225c8a1b4b69bc927d2d05613451bbbeba0aed16ca1fef391caa8d5ead
|
|
| MD5 |
19d22463dc4f552e424210498db181bd
|
|
| BLAKE2b-256 |
a639994d57e287cb1d7d7393e76b28e3737861e4b134c2bf93cae5ad5cf4f7e9
|