API Reference¶
SeekMe SDK package.
Client
¶
Unified client that composes DB, vector, and embedding components.
Source code in src/seekme/client.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
db
property
¶
Return the database component.
embedder
property
¶
Return the embedding component.
vector_store
property
¶
Return the vector store component.
close()
¶
Close underlying components when supported.
Source code in src/seekme/client.py
70 71 72 73 74 | |
connect()
¶
Explicitly connect underlying components when supported.
Source code in src/seekme/client.py
63 64 65 66 67 68 | |
from_database_url(url, *, db_driver=DEFAULT_DB_DRIVER, **driver_kwargs)
classmethod
¶
Create a client from a database URL using a registered driver.
Source code in src/seekme/client.py
27 28 29 30 31 32 33 34 35 36 37 38 39 | |
ConfigurationError
¶
Bases: SeekMeError
Raised when configuration is invalid or incomplete.
Source code in src/seekme/exceptions.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | |
DatabaseError
¶
Bases: SeekMeError
Raised when database operations fail.
Source code in src/seekme/exceptions.py
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 | |
EmbeddingError
¶
Bases: SeekMeError
Raised when embedding operations fail.
Source code in src/seekme/exceptions.py
71 72 73 74 75 76 77 78 79 80 81 82 83 | |
SeekMeError
¶
Bases: Exception
Base error for the SDK.
Source code in src/seekme/exceptions.py
6 7 | |
ValidationError
¶
Bases: ValueError, SeekMeError
Raised when user input fails validation.
Source code in src/seekme/exceptions.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 | |
Unified SDK client entrypoint.
Client
¶
Unified client that composes DB, vector, and embedding components.
Source code in src/seekme/client.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
db
property
¶
Return the database component.
embedder
property
¶
Return the embedding component.
vector_store
property
¶
Return the vector store component.
close()
¶
Close underlying components when supported.
Source code in src/seekme/client.py
70 71 72 73 74 | |
connect()
¶
Explicitly connect underlying components when supported.
Source code in src/seekme/client.py
63 64 65 66 67 68 | |
from_database_url(url, *, db_driver=DEFAULT_DB_DRIVER, **driver_kwargs)
classmethod
¶
Create a client from a database URL using a registered driver.
Source code in src/seekme/client.py
27 28 29 30 31 32 33 34 35 36 37 38 39 | |
Core database interfaces and primitives.
Database
¶
Bases: ABC
Abstract database interface for executing SQL and managing transactions.
Source code in src/seekme/db/core.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 | |
begin()
abstractmethod
¶
Begin a transaction.
Source code in src/seekme/db/core.py
33 34 35 | |
close()
abstractmethod
¶
Close the underlying connection.
Source code in src/seekme/db/core.py
17 18 19 | |
commit()
abstractmethod
¶
Commit the current transaction.
Source code in src/seekme/db/core.py
37 38 39 | |
connect()
abstractmethod
¶
Open the underlying connection.
Source code in src/seekme/db/core.py
13 14 15 | |
execute(sql, params=None)
abstractmethod
¶
Execute a statement and return affected row count.
Source code in src/seekme/db/core.py
21 22 23 | |
fetch_all(sql, params=None)
abstractmethod
¶
Execute a query and return all rows.
Source code in src/seekme/db/core.py
25 26 27 | |
fetch_one(sql, params=None)
abstractmethod
¶
Execute a query and return one row.
Source code in src/seekme/db/core.py
29 30 31 | |
rollback()
abstractmethod
¶
Rollback the current transaction.
Source code in src/seekme/db/core.py
41 42 43 | |
Vector storage interfaces.
VectorStore
¶
Bases: ABC
Abstract vector store interface.
Source code in src/seekme/vector/core.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | |
create_collection(name, dimension)
abstractmethod
¶
Create a vector collection.
Source code in src/seekme/vector/core.py
15 16 17 | |
delete_collection(name)
abstractmethod
¶
Delete a vector collection.
Source code in src/seekme/vector/core.py
19 20 21 | |
search(collection, query, top_k, *, where=None, return_fields=None, include_distance=True, include_metadata=True)
abstractmethod
¶
Search the vector store and return results.
When return_fields is provided, include_metadata is ignored.
include_distance remains effective and adds _distance when enabled.
Source code in src/seekme/vector/core.py
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | |
upsert(collection, ids, vectors, metadatas=None)
abstractmethod
¶
Insert or update vectors.
Source code in src/seekme/vector/core.py
23 24 25 26 27 28 29 30 31 | |
Embedding provider interfaces.
Embedder
¶
Bases: Protocol
Protocol for embedding providers.
Source code in src/seekme/embeddings/base.py
11 12 13 14 15 16 | |
embed(texts)
¶
Return embeddings for input texts.
Source code in src/seekme/embeddings/base.py
15 16 | |
Remote embedding provider adapter.
RemoteEmbedder
¶
Bases: Embedder
Embedding provider backed by a hosted embedding API.
Source code in src/seekme/embeddings/remote.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 | |
Local embedding provider adapter.
LocalEmbedder
¶
Bases: Embedder
Embedding provider backed by sentence-transformers.
Source code in src/seekme/embeddings/local.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 | |
Registry for SDK extension points.
ensure_defaults()
¶
Load default implementations into the registry.
Source code in src/seekme/registry.py
92 93 94 95 96 97 98 99 100 101 | |
get_db_driver(name)
¶
Return the database driver factory for the given name.
Source code in src/seekme/registry.py
44 45 46 47 48 49 50 51 | |
get_embedder(name)
¶
Return the embedder factory for the given name.
Source code in src/seekme/registry.py
64 65 66 67 68 69 70 71 | |
get_vector_store(name)
¶
Return the vector store factory for the given name.
Source code in src/seekme/registry.py
54 55 56 57 58 59 60 61 | |
list_db_drivers()
¶
List registered database driver names.
Source code in src/seekme/registry.py
74 75 76 77 | |
list_embedders()
¶
List registered embedder names.
Source code in src/seekme/registry.py
86 87 88 89 | |
list_vector_stores()
¶
List registered vector store names.
Source code in src/seekme/registry.py
80 81 82 83 | |
register_db_driver(name, factory)
¶
Register a database driver factory.
Source code in src/seekme/registry.py
26 27 28 29 | |
register_embedder(name, factory)
¶
Register an embedder factory.
Source code in src/seekme/registry.py
38 39 40 41 | |
register_vector_store(name, factory)
¶
Register a vector store factory.
Source code in src/seekme/registry.py
32 33 34 35 | |