llama-index-retrievers-mongodb-atlas-bm25-retriever

Name	llama-index-retrievers-mongodb-atlas-bm25-retriever JSON
Version	0.3.0 JSON
	download
home_page	None
Summary	llama-index retrievers mongodb-atlas-bm25-retriever integration
upload_time	2024-11-17 23:00:28
maintainer	None
docs_url	None
author	Your Name
requires_python	<4.0,>=3.9
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # LlamaIndex Retrievers Integration: MongoDBAtlasBM25Retriever

## What is this?

This is a BM25 Retriever for MongoDB Atlas that can be used with LlamaIndex.

## How to use

This was created with reference to [MongoDBAtlasVectorSearch](https://docs.llamaindex.ai/en/stable/examples/vector_stores/MongoDBAtlasVectorSearch.html), so it's mostly the same.

Please refer to that.

However, while `MongoDBAtlasVectorSearch` is an VectorStore, `MongoDBAtlasBM25Retriever` is a Retriever.

MongoDBAtlasBM25Retriever Example:

```python
mongodb_client = pymongo.MongoClient(mongo_uri)

retriever = MongoDBAtlasBM25Retriever(
    mongodb_client=mongodb_client,
    db_name="vectorstore",
    collection_name="vector_collection",
    index_name="index_vector_collection",
)
nodes = retriever.retrieve("retrieve_query")
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "llama-index-retrievers-mongodb-atlas-bm25-retriever",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Your Name",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/94/c9/85996d6d971817a2da3420ddad5e3d1995a02245e7764e5692ebb4768f6e/llama_index_retrievers_mongodb_atlas_bm25_retriever-0.3.0.tar.gz",
    "platform": null,
    "description": "# LlamaIndex Retrievers Integration: MongoDBAtlasBM25Retriever\n\n## What is this?\n\nThis is a BM25 Retriever for MongoDB Atlas that can be used with LlamaIndex.\n\n## How to use\n\nThis was created with reference to [MongoDBAtlasVectorSearch](https://docs.llamaindex.ai/en/stable/examples/vector_stores/MongoDBAtlasVectorSearch.html), so it's mostly the same.\n\nPlease refer to that.\n\nHowever, while `MongoDBAtlasVectorSearch` is an VectorStore, `MongoDBAtlasBM25Retriever` is a Retriever.\n\nMongoDBAtlasBM25Retriever Example:\n\n```python\nmongodb_client = pymongo.MongoClient(mongo_uri)\n\nretriever = MongoDBAtlasBM25Retriever(\n    mongodb_client=mongodb_client,\n    db_name=\"vectorstore\",\n    collection_name=\"vector_collection\",\n    index_name=\"index_vector_collection\",\n)\nnodes = retriever.retrieve(\"retrieve_query\")\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "llama-index retrievers mongodb-atlas-bm25-retriever integration",
    "version": "0.3.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0ce3d404759ca0fcbe95136927cacbfe473d892dbb3ebd51ba0d68fdbac90385",
                "md5": "7a7d74a24f4812c131436e26dc8b9e51",
                "sha256": "b642cb9bb8d523a94d9f637c998bc3adbd1541be15b7c1bf1ac338304c924dd7"
            },
            "downloads": -1,
            "filename": "llama_index_retrievers_mongodb_atlas_bm25_retriever-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7a7d74a24f4812c131436e26dc8b9e51",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 3538,
            "upload_time": "2024-11-17T23:00:27",
            "upload_time_iso_8601": "2024-11-17T23:00:27.767054Z",
            "url": "https://files.pythonhosted.org/packages/0c/e3/d404759ca0fcbe95136927cacbfe473d892dbb3ebd51ba0d68fdbac90385/llama_index_retrievers_mongodb_atlas_bm25_retriever-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "94c985996d6d971817a2da3420ddad5e3d1995a02245e7764e5692ebb4768f6e",
                "md5": "9a1e05d0c43c7f7ba0243c6c55310424",
                "sha256": "a17053cb1e145077a8bb5d86886bdc63bbf17735c6e6c25473718092b1b77ad2"
            },
            "downloads": -1,
            "filename": "llama_index_retrievers_mongodb_atlas_bm25_retriever-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9a1e05d0c43c7f7ba0243c6c55310424",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 3075,
            "upload_time": "2024-11-17T23:00:28",
            "upload_time_iso_8601": "2024-11-17T23:00:28.643691Z",
            "url": "https://files.pythonhosted.org/packages/94/c9/85996d6d971817a2da3420ddad5e3d1995a02245e7764e5692ebb4768f6e/llama_index_retrievers_mongodb_atlas_bm25_retriever-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-17 23:00:28",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-retrievers-mongodb-atlas-bm25-retriever"
}