velesdb-common
Shared utilities for VelesDB Python integrations.
This package is not a public API. End users should install and import from
langchain-velesdb,llama-index-vector-stores-velesdb, orhaystack-velesdbdirectly.
What it provides
velesdb-common centralizes code shared by all three Python RAG framework integration packages:
- Security validators — input sanitization for collection names, dimensions, queries, URLs
- ID generation — deterministic hashing and sequential ID counters
- Graph helpers — REST payload builders and native graph bindings
- Memory formatting — procedural memory result formatting
Public Exports
The following symbols form the stable internal API consumed by langchain-velesdb,
llama-index-vector-stores-velesdb, and haystack-velesdb. They are not intended for
direct use by end users.
Fusion
| Export | Type | Description |
|---|---|---|
build_fusion_strategy |
function | Converts a strategy name + params dict into the native FusionStrategy object |
Shared mixins / bases
| Export | Type | Description |
|---|---|---|
CollectionAdminMixin |
class | Mixin providing shared admin operations (create_metadata_collection, is_metadata_only, train_pq, analyze_collection, get_collection_stats) |
GraphOpsBase |
class | Base class for graph query helpers used by both integrations |
ID helpers
| Export | Type | Description |
|---|---|---|
stable_hash_id |
function | Deterministic 64-bit hash of an input string (used as collection-stable ID). SHA-256 by default; pass algorithm="fnv1a" to align with VelesDB core's/velesdb-migrate's FNV-1a IDs — see KNOWN_LIMITATIONS #12 before switching |
make_initial_id_counter |
function | Builds a thread-safe sequential ID counter seeded from existing collection state |
Memory helpers
| Export | Type | Description |
|---|---|---|
format_procedural_results |
function | Normalizes raw procedural-memory recall output into a stable result list |
store_procedure |
function | Inserts a procedural-memory entry with the canonical schema used by both integrations |
Security: validators
| Export | Type | Description |
|---|---|---|
SecurityError |
exception | Raised by every validate_* on rejected input |
validate_url |
function | Validates a server URL string |
validate_text |
function | Sanitizes free-text query strings against injection patterns |
validate_query |
function | Validates VelesQL query strings against length / character limits |
validate_collection_name |
function | Alphanumeric + underscore, ≤ 64 chars |
validate_dimension |
function | Within MIN_DIMENSION..=MAX_DIMENSION |
validate_metric |
function | Against ALLOWED_METRICS |
validate_storage_mode |
function | Against ALLOWED_STORAGE_MODES / STORAGE_MODE_ALIASES |
validate_path |
function | Filesystem path bounds + character rules |
validate_k |
function | k value in [1, MAX_K_VALUE] |
validate_batch_size |
function | Batch size in [1, MAX_BATCH_SIZE] |
validate_timeout |
function | Timeout ms within sane bounds |
validate_weight |
function | Fusion weight in [0.0, 1.0] |
validate_sparse_vector |
function | Sparse pair list bounds |
Security: constants
| Export | Type | Description |
|---|---|---|
ALLOWED_METRICS |
set | Canonical metric strings (cosine, euclidean, dot, …); single-sourced from velesdb.DISTANCE_METRICS, with a literal fallback when the wheel is absent |
ALLOWED_STORAGE_MODES |
set | Canonical storage modes (full, sq8, binary, pq, rabitq); single-sourced from velesdb.STORAGE_MODES, with a literal fallback when the wheel is absent |
STORAGE_MODE_ALIASES |
dict | Alias → canonical mapping (e.g. int8 → sq8) |
DEFAULT_TIMEOUT_MS |
int | Default timeout used when callers don't specify one |
MIN_DIMENSION / MAX_DIMENSION |
int | Vector dimension bounds |
MAX_BATCH_SIZE |
int | Hard cap on per-call batch operations |
MAX_K_VALUE |
int | Hard cap on retrieval k |
MAX_PATH_LENGTH |
int | Filesystem path length cap |
MAX_QUERY_LENGTH |
int | VelesQL query length cap |
MAX_SPARSE_VECTOR_SIZE |
int | Sparse vector non-zero entry cap |
MAX_TEXT_LENGTH |
int | Free-text query length cap |
Graph helpers
| Export | Type | Description |
|---|---|---|
build_graph_rest_payload |
function | Constructs the JSON body for REST-backed graph traversal calls |
parse_graph_traverse_response |
function | Decodes a graph traversal REST response into the shared result shape |
open_native_graph |
function | Opens (or attaches to) a native-backend graph collection |
is_timeout_exception |
function | Cross-backend timeout-error predicate |
License
MIT License (this integration). See LICENSE for details.
VelesDB Core itself is licensed under the VelesDB Core License 1.0 (based on ELv2).
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
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 velesdb_common-4.1.0.tar.gz.
File metadata
- Download URL: velesdb_common-4.1.0.tar.gz
- Upload date:
- Size: 26.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
210006d6e84ea7a893d3d2e9bad7a23b40a4350c3a6ba27a74a35d6e5cc95b19
|
|
| MD5 |
0379cdbf6c8eae561987cd6979bceaa7
|
|
| BLAKE2b-256 |
a970865f0cacf1a0314e76fb53b5d521c46db0b4e321461c504b75f5883d59bc
|
File details
Details for the file velesdb_common-4.1.0-py3-none-any.whl.
File metadata
- Download URL: velesdb_common-4.1.0-py3-none-any.whl
- Upload date:
- Size: 22.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f1268bdd4b072e70a7e7f4d512792ddb5d58af9d0304f6ed780280d167ce91e9
|
|
| MD5 |
aa3ae519be589992a6693088d5c6f240
|
|
| BLAKE2b-256 |
a9a68252a3d87273872fceea5f3af82bc99452576b3c15779b9bbbef88e657bd
|
