Mongodb
MongoDBAtlasVectorSearch #
MongoDB Atlas 向量存储。
使用前,您需要具备以下条件:
- 已安装 pymongo
Python 包
- 拥有与 MongoDB Atlas 集群关联的连接字符串
该集群需包含 Atlas Vector Search 索引
要开始使用,请前往Atlas快速入门。
创建存储后,请确保在Atlas图形界面中启用索引功能。
请参阅文档获取关于如何定义Atlas向量搜索索引的更多详细信息。您可以将索引命名为{ATLAS_VECTOR_SEARCH_INDEX_NAME}并在命名空间{DB_NAME}.{COLLECTION_NAME}上创建该索引。
最后,在MongoDB Atlas的JSON编辑器中写入以下定义:
{
"name": "vector_index",
"type": "vectorSearch",
"fields":[
{
"type": "vector",
"path": "embedding",
"numDimensions": 1536,
"similarity": "cosine"
}
]
}
可选地,您可以使用该类上的实验性便捷方法来管理向量搜索索引和全文索引。
示例:
pip install llama-index-vector-stores-mongodb
import pymongo
from llama_index.vector_stores.mongodb import MongoDBAtlasVectorSearch
# Ensure you have the MongoDB URI with appropriate credentials
mongo_uri = "mongodb+srv://<username>:<password>@<host>?retryWrites=true&w=majority"
mongodb_client = pymongo.MongoClient(mongo_uri)
# Create an instance of MongoDBAtlasVectorSearch
vector_store = MongoDBAtlasVectorSearch(mongodb_client)
# Create a vector search index programmatically
vector_store.create_vector_search_index(path="embedding", dimensions=1536, similarity="cosine")
# Create a text search index programmatically
vector_store.create_fulltext_search_index("foo)
Source code in llama-index-integrations/vector_stores/llama-index-vector-stores-mongodb/llama_index/vector_stores/mongodb/base.py
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 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 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 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 |
|
添加 #
add(nodes: List[BaseNode], **add_kwargs: Any) -> List[str]
将节点添加到索引。
参数:
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
nodes
|
List[BaseNode]
|
List[BaseNode]: 带有嵌入向量的节点列表 |
required |
返回:
类型 | 描述 |
---|---|
List[str]
|
成功添加节点的ID列表。 |
Source code in llama-index-integrations/vector_stores/llama-index-vector-stores-mongodb/llama_index/vector_stores/mongodb/base.py
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
|
删除 #
delete(ref_doc_id: str, **delete_kwargs: Any) -> None
使用ref_doc_id删除节点。
参数:
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
ref_doc_id
|
str
|
要删除的文档的doc_id。 |
required |
Source code in llama-index-integrations/vector_stores/llama-index-vector-stores-mongodb/llama_index/vector_stores/mongodb/base.py
237 238 239 240 241 242 243 244 245 246 247 248 |
|
查询 #
query(query: VectorStoreQuery, **kwargs: Any) -> VectorStoreQueryResult
查询索引以获取前k个最相似的节点。
执行的搜索类型基于VectorStoreQuery.mode。 可选模式包括DEFAULT(向量)、HYBRID(混合)或TEXT_SEARCH(全文)。 当模式为HYBRID或TEXT_SEARCH时, VectorStoreQuery.query_str将用于全文搜索。 有关这些模式的完整详情,请参阅MongoDB Atlas文档。
关于VectorStoreQueryMode.DEFAULT == 'default'的详细信息, 该模式执行向量搜索,请参阅: https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-stage/
有关VectorStoreQueryMode.TEXT_SEARCH == "text_search"的详细信息, 该模式执行全文搜索,请参阅: https://www.mongodb.com/docs/atlas/atlas-search/aggregation-stages/search/#mongodb-pipeline-pipe.-search
关于VectorStoreQueryMode.HYBRID == "hybrid"的详细信息,它通过互惠排名融合将两者结合,请参阅以下内容。 https://www.mongodb.com/docs/atlas/atlas-vector-search/tutorials/reciprocal-rank-fusion/
在使用的评分算法中,互逆排名融合(Reciprocal Rank Fusion), 分数 := \frac{1}{rank + penalty},其中排名在[1,2,..,n]范围内
参数:
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
query
|
VectorStoreQuery
|
一个VectorStoreQuery对象。 |
required |
返回:
类型 | 描述 |
---|---|
VectorStoreQueryResult
|
包含查询结果的VectorStoreQueryResult。 |
Source code in llama-index-integrations/vector_stores/llama-index-vector-stores-mongodb/llama_index/vector_stores/mongodb/base.py
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 |
|
create_vector_search_index #
create_vector_search_index(dimensions: int, path: str, similarity: str, filters: Optional[List[str]] = None, *, wait_until_complete: Optional[float] = None, **kwargs: Any) -> None
实验性工具函数,用于为此存储创建向量搜索索引。
参数:
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
dimensions
|
int
|
嵌入的维度数量 |
required |
path
|
str
|
带有向量嵌入的字段 |
required |
similarity
|
str
|
用于索引的相似度评分 |
required |
filters
|
List[str]
|
用于索引的字段/路径,以便在$vectorSearch中进行过滤 |
None
|
wait_until_complete
|
Optional[float]
|
如果提供,则等待搜索索引准备就绪的秒数。 |
None
|
kwargs
|
Any
|
为SearchIndexModel提供任何额外选项的关键字参数。 |
{}
|
Source code in llama-index-integrations/vector_stores/llama-index-vector-stores-mongodb/llama_index/vector_stores/mongodb/base.py
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 |
|
删除向量搜索索引 #
drop_vector_search_index(*, wait_until_complete: Optional[float] = None) -> None
删除为此存储创建的向量搜索索引。
参数:
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
wait_until_complete
|
Optional[float]
|
如果提供,等待搜索索引准备就绪的秒数。 |
None
|
Source code in llama-index-integrations/vector_stores/llama-index-vector-stores-mongodb/llama_index/vector_stores/mongodb/base.py
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 |
|
update_vector_search_index #
update_vector_search_index(dimensions: int, path: str, similarity: str, filters: Optional[List[str]] = None, *, wait_until_complete: Optional[float] = None, **kwargs: Any) -> None
更新此存储的向量搜索索引。
用提供的定义替换现有的索引定义。
参数:
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
dimensions
|
int
|
嵌入的维度数量 |
required |
path
|
str
|
带有向量嵌入的字段 |
required |
similarity
|
str
|
用于索引的相似度评分。 |
required |
filters
|
List[str]
|
用于索引的字段/路径,以便在$vectorSearch中进行过滤 |
None
|
wait_until_complete
|
Optional[float]
|
如果提供,则等待搜索索引准备就绪的秒数。 |
None
|
kwargs
|
Any
|
提供任何额外选项给SearchIndexModel的关键字参数。 |
{}
|
Source code in llama-index-integrations/vector_stores/llama-index-vector-stores-mongodb/llama_index/vector_stores/mongodb/base.py
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 |
|
create_fulltext_search_index #
create_fulltext_search_index(field: str, field_type: str = 'string', *, wait_until_complete: Optional[float] = None, **kwargs: Any) -> None
实验性工具函数,用于为此存储创建Atlas搜索索引。
参数:
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
field
|
str
|
需要索引的字段 |
required |
wait_until_complete
|
Optional[float]
|
如果提供,等待搜索索引准备就绪的秒数 |
None
|
kwargs
|
Any
|
提供任何额外选项给SearchIndexModel的关键字参数。 |
{}
|
Source code in llama-index-integrations/vector_stores/llama-index-vector-stores-mongodb/llama_index/vector_stores/mongodb/base.py
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 |
|