Class swarmauri_vectorstore_qdrant.PersistentQdrantVectorStore.PersistentQdrantVectorStore
swarmauri_vectorstore_qdrant.PersistentQdrantVectorStore.PersistentQdrantVectorStore
PersistentQdrantVectorStore(**kwargs)
Bases: VectorStoreSaveLoadMixin
, VectorStoreRetrieveMixin
, VectorStorePersistentMixin
, VectorStoreBase
PersistentQdrantVectorStore is a concrete implementation that integrates functionality for saving, loading, storing, and retrieving vector documents, leveraging a locally hosted Qdrant instance as the backend.
Source code in swarmauri_vectorstore_qdrant/PersistentQdrantVectorStore.py
51 52 53 54 55 |
|
type
class-attribute
instance-attribute
type = 'PersistentQdrantVectorStore'
model_config
class-attribute
instance-attribute
model_config = ConfigDict(arbitrary_types_allowed=True)
client
class-attribute
instance-attribute
client = Field(default=None, init=False)
id
class-attribute
instance-attribute
id = Field(default_factory=generate_id)
members
class-attribute
instance-attribute
members = None
owners
class-attribute
instance-attribute
owners = None
host
class-attribute
instance-attribute
host = None
default_logger
class-attribute
default_logger = None
logger
class-attribute
instance-attribute
logger = None
name
class-attribute
instance-attribute
name = None
version
class-attribute
instance-attribute
version = '0.1.0'
documents
class-attribute
instance-attribute
documents = []
embedder
property
embedder
collection_name
instance-attribute
collection_name
collection
class-attribute
instance-attribute
collection = Field(
None,
description="Collection object for interacting with the persistent-based store",
)
path
class-attribute
instance-attribute
path = Field(
None,
description="URL of the persistent-based store to connect to",
)
vector_size
class-attribute
instance-attribute
vector_size = Field(
None,
description="Size of the vectors used in the store",
)
vectorizer
class-attribute
instance-attribute
vectorizer = Field(
None,
description="Vectorizer object for converting documents to vectors",
)
connect
connect()
Connects to the Qdrant vector store using the provided URL.
Source code in swarmauri_vectorstore_qdrant/PersistentQdrantVectorStore.py
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
|
disconnect
disconnect()
Disconnects from the Qdrant vector store.
Source code in swarmauri_vectorstore_qdrant/PersistentQdrantVectorStore.py
77 78 79 80 81 82 |
|
add_document
add_document(document)
Add a single document to the document store.
PARAMETER | DESCRIPTION |
---|---|
document
|
The document to be added to the store.
TYPE:
|
Source code in swarmauri_vectorstore_qdrant/PersistentQdrantVectorStore.py
84 85 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 |
|
add_documents
add_documents(documents)
Add multiple documents to the document store in a batch operation.
PARAMETER | DESCRIPTION |
---|---|
documents
|
A list of documents to be added to the store.
TYPE:
|
Source code in swarmauri_vectorstore_qdrant/PersistentQdrantVectorStore.py
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
|
get_document
get_document(id)
Retrieve a single document by its identifier.
PARAMETER | DESCRIPTION |
---|---|
id
|
The unique identifier of the document to retrieve.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Union[Document, None]
|
Union[Document, None]: The requested document if found; otherwise, None. |
Source code in swarmauri_vectorstore_qdrant/PersistentQdrantVectorStore.py
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
|
get_all_documents
get_all_documents()
Retrieve all documents stored in the document store.
RETURNS | DESCRIPTION |
---|---|
List[Document]
|
List[Document]: A list of all documents in the store. |
Source code in swarmauri_vectorstore_qdrant/PersistentQdrantVectorStore.py
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
|
delete_document
delete_document(id)
Delete a document from the document store by its identifier.
PARAMETER | DESCRIPTION |
---|---|
id
|
The unique identifier of the document to delete.
TYPE:
|
Source code in swarmauri_vectorstore_qdrant/PersistentQdrantVectorStore.py
171 172 173 174 175 176 177 178 |
|
update_document
update_document(id, updated_document)
Update a document in the document store.
PARAMETER | DESCRIPTION |
---|---|
id
|
The unique identifier of the document to update.
TYPE:
|
updated_document
|
The updated document instance.
TYPE:
|
Source code in swarmauri_vectorstore_qdrant/PersistentQdrantVectorStore.py
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
|
clear_documents
clear_documents()
Deletes all documents from the vector store.
Source code in swarmauri_vectorstore_qdrant/PersistentQdrantVectorStore.py
211 212 213 214 215 |
|
document_count
document_count()
Returns the number of documents in the store.
Source code in swarmauri_vectorstore_qdrant/PersistentQdrantVectorStore.py
217 218 219 220 221 222 223 224 |
|
retrieve
retrieve(query, top_k=5)
Retrieve the top_k most relevant documents based on the given query. For the purpose of this example, this method performs a basic search.
PARAMETER | DESCRIPTION |
---|---|
query
|
The query string used for document retrieval.
TYPE:
|
top_k
|
The number of top relevant documents to retrieve.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
List[Document]
|
List[Document]: A list of the top_k most relevant documents. |
Source code in swarmauri_vectorstore_qdrant/PersistentQdrantVectorStore.py
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 |
|
model_dump_json
model_dump_json(*args, **kwargs)
Source code in swarmauri_vectorstore_qdrant/PersistentQdrantVectorStore.py
253 254 255 256 257 258 |
|
register_model
classmethod
register_model()
Decorator to register a base model in the unified registry.
RETURNS | DESCRIPTION |
---|---|
Callable
|
A decorator function that registers the model class.
TYPE:
|
Source code in swarmauri_base/DynamicBase.py
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 |
|
register_type
classmethod
register_type(resource_type=None, type_name=None)
Decorator to register a subtype under one or more base models in the unified registry.
PARAMETER | DESCRIPTION |
---|---|
resource_type
|
The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase) are used.
TYPE:
|
type_name
|
An optional custom type name for the subtype.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Callable
|
A decorator function that registers the subtype.
TYPE:
|
Source code in swarmauri_base/DynamicBase.py
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 |
|
model_validate_toml
classmethod
model_validate_toml(toml_data)
Validate a model from a TOML string.
Source code in swarmauri_base/TomlMixin.py
12 13 14 15 16 17 18 19 20 21 22 23 24 |
|
model_dump_toml
model_dump_toml(
fields_to_exclude=None, api_key_placeholder=None
)
Return a TOML representation of the model.
Source code in swarmauri_base/TomlMixin.py
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 |
|
model_validate_yaml
classmethod
model_validate_yaml(yaml_data)
Validate a model from a YAML string.
Source code in swarmauri_base/YamlMixin.py
11 12 13 14 15 16 17 18 19 20 21 22 23 |
|
model_dump_yaml
model_dump_yaml(
fields_to_exclude=None, api_key_placeholder=None
)
Return a YAML representation of the model.
Source code in swarmauri_base/YamlMixin.py
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 |
|
model_post_init
model_post_init(logger=None)
Assign a logger instance after model initialization.
Source code in swarmauri_base/LoggerMixin.py
23 24 25 26 27 28 |
|
document_dumps
document_dumps()
Placeholder
Source code in swarmauri_base/vector_stores/VectorStoreBase.py
104 105 106 107 108 |
|
document_dump
document_dump(file_path)
Placeholder
Source code in swarmauri_base/vector_stores/VectorStoreBase.py
110 111 112 113 114 115 116 117 118 119 120 |
|
document_loads
document_loads(json_data)
Placeholder
Source code in swarmauri_base/vector_stores/VectorStoreBase.py
122 123 124 125 126 127 128 |
|
document_load
document_load(file_path)
Placeholder
Source code in swarmauri_base/vector_stores/VectorStoreBase.py
130 131 132 133 134 135 136 137 |
|
save_store
save_store(directory_path)
Saves both the vectorizer's model and the documents.
Source code in swarmauri_base/vector_stores/VectorStoreSaveLoadMixin.py
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
|
load_store
load_store(directory_path)
Loads both the vectorizer's model and the documents.
Source code in swarmauri_base/vector_stores/VectorStoreSaveLoadMixin.py
38 39 40 41 42 43 44 45 46 47 48 49 |
|
save_parts
save_parts(directory_path, chunk_size=10485760)
Splits the file into parts if it's too large and saves those parts individually.
Source code in swarmauri_base/vector_stores/VectorStoreSaveLoadMixin.py
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
|
load_parts
load_parts(directory_path, file_pattern='*.part*')
Combines file parts from a directory back into a single file and loads it.
Source code in swarmauri_base/vector_stores/VectorStoreSaveLoadMixin.py
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
|