mongodb_atlas
__all__ = ['MongoDbAtlasVectorStoreDriver']
module-attribute
MongoDbAtlasVectorStoreDriver
Bases: BaseVectorStoreDriver
A Vector Store Driver for MongoDb Atlas.
Attributes:
Name | Type | Description |
---|---|---|
connection_string |
str
|
The connection string for the MongoDb Atlas cluster. |
database_name |
str
|
The name of the database to use. |
collection_name |
str
|
The name of the collection to use. |
index_name |
str
|
The name of the index to use. |
vector_path |
str
|
The path to the vector field in the collection. |
client |
MongoClient
|
An optional MongoDb client to use. Defaults to a new client using the connection string. |
Source code in griptape/drivers/vector/mongodb_atlas_vector_store_driver.py
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 81 82 83 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 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 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
|
MAX_NUM_CANDIDATES = 10000
class-attribute
instance-attribute
collection_name: str = field(kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
connection_string: str = field(kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
database_name: str = field(kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
index_name: str = field(kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
num_candidates_multiplier: int = field(default=10, kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
vector_path: str = field(kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
client()
delete_vector(vector_id)
Deletes the vector from the collection.
get_collection()
Returns the MongoDB Collection instance for the specified database and collection name.
load_entries(*, namespace=None)
Loads all document entries from the MongoDB collection.
Entries can optionally be filtered by namespace.
Source code in griptape/drivers/vector/mongodb_atlas_vector_store_driver.py
load_entry(vector_id, *, namespace=None)
Loads a document entry from the MongoDB collection based on the vector ID.
Returns:
Type | Description |
---|---|
Optional[Entry]
|
The loaded Entry if found; otherwise, None is returned. |
Source code in griptape/drivers/vector/mongodb_atlas_vector_store_driver.py
query(query, *, count=None, namespace=None, include_vectors=False, offset=None, **kwargs)
Queries the MongoDB collection for documents that match the provided query string.
Results can be customized based on parameters like count, namespace, inclusion of vectors, offset, and index.
Source code in griptape/drivers/vector/mongodb_atlas_vector_store_driver.py
query_vector(vector, *, count=None, namespace=None, include_vectors=False, offset=None, **kwargs)
Queries the MongoDB collection for documents that match the provided vector list.
Results can be customized based on parameters like count, namespace, inclusion of vectors, offset, and index.
Source code in griptape/drivers/vector/mongodb_atlas_vector_store_driver.py
upsert_vector(vector, *, vector_id=None, namespace=None, meta=None, **kwargs)
Inserts or updates a vector in the collection.
If a vector with the given vector ID already exists, it is updated; otherwise, a new vector is inserted.