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

Name	llama-index-retrievers-mongodb-atlas-bm25-retriever JSON
Version	0.2.0 JSON
	download
home_page	None
Summary	llama-index retrievers mongodb-atlas-bm25-retriever integration
upload_time	2024-08-22 07:17:34
maintainer	None
docs_url	None
author	Your Name
requires_python	<4.0,>=3.8.1
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.8.1",
    "maintainer_email": null,
    "keywords": null,
    "author": "Your Name",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/92/a3/1a2403f83f1b30b4eceffdf92c0e64c852b0ea48404f74e7f554e7260ac1/llama_index_retrievers_mongodb_atlas_bm25_retriever-0.2.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.2.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2ab0ba97f34bacbb0e78a549fcb2204607f99909f961b32a86c2491e22a431a6",
                "md5": "fbddc913abee2386136aff29dc06d61b",
                "sha256": "161be8049f9ed0e5d066e4a9a7d3fa803adac187e679e009a08acc246d913376"
            },
            "downloads": -1,
            "filename": "llama_index_retrievers_mongodb_atlas_bm25_retriever-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fbddc913abee2386136aff29dc06d61b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8.1",
            "size": 3537,
            "upload_time": "2024-08-22T07:17:33",
            "upload_time_iso_8601": "2024-08-22T07:17:33.222822Z",
            "url": "https://files.pythonhosted.org/packages/2a/b0/ba97f34bacbb0e78a549fcb2204607f99909f961b32a86c2491e22a431a6/llama_index_retrievers_mongodb_atlas_bm25_retriever-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "92a31a2403f83f1b30b4eceffdf92c0e64c852b0ea48404f74e7f554e7260ac1",
                "md5": "a06a7bfd852fee07e45a82e62f7f98ef",
                "sha256": "0fa016e540bbbbf7ea385127e2a17fb73fd5d9aac8dca0bb9a40da07ee596d66"
            },
            "downloads": -1,
            "filename": "llama_index_retrievers_mongodb_atlas_bm25_retriever-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a06a7bfd852fee07e45a82e62f7f98ef",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8.1",
            "size": 3074,
            "upload_time": "2024-08-22T07:17:34",
            "upload_time_iso_8601": "2024-08-22T07:17:34.425572Z",
            "url": "https://files.pythonhosted.org/packages/92/a3/1a2403f83f1b30b4eceffdf92c0e64c852b0ea48404f74e7f554e7260ac1/llama_index_retrievers_mongodb_atlas_bm25_retriever-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-22 07:17:34",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-retrievers-mongodb-atlas-bm25-retriever"
}