# Auto Merging Retriever Pack
This LlamaPack provides an example of our auto-merging retriever.
This specific template shows the e2e process of building this. It loads
a document, builds a hierarchical node graph (with bigger parent nodes and smaller
child nodes).
Check out the [notebook here](https://github.com/run-llama/llama-hub/blob/main/llama_hub/llama_packs/auto_merging_retriever/auto_merging_retriever.ipynb).
## CLI Usage
You can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:
```bash
llamaindex-cli download-llamapack AutoMergingRetrieverPack --download-dir ./auto_merging_retriever_pack
```
You can then inspect the files at `./auto_merging_retriever_pack` and use them as a template for your own project.
## Code Usage
You can download the pack to a the `./auto_merging_retriever_pack` directory:
```python
from llama_index.core.llama_pack import download_llama_pack
# download and install dependencies
AutoMergingRetrieverPack = download_llama_pack(
"AutoMergingRetrieverPack", "./auto_merging_retriever_pack"
)
```
From here, you can use the pack, or inspect and modify the pack in `./auto_merging_retriever_pack`.
Then, you can set up the pack like so:
```python
# create the pack
# get documents from any data loader
auto_merging_retriever_pack = AutoMergingRetrieverPack(
documents,
)
```
The `run()` function is a light wrapper around `query_engine.query()`.
```python
response = auto_merging_retriever_pack.run(
"Tell me about what the author did growing up."
)
```
You can also use modules individually.
```python
# get the node parser
node_parser = auto_merging_retriever_pack.node_parser
# get the retriever
retriever = auto_merging_retriever_pack.retriever
# get the query engine
query_engine = auto_merging_retriever_pack.query_engine
```
Raw data
{
"_id": null,
"home_page": "",
"name": "llama-index-packs-auto-merging-retriever",
"maintainer": "jerryjliu",
"docs_url": null,
"requires_python": ">=3.8.1,<3.12",
"maintainer_email": "",
"keywords": "auto,automerging,index,merging,retriever",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/33/16/deca44a6c11c4d846478f6392917045b0eadff4952343213d200fe945e11/llama_index_packs_auto_merging_retriever-0.1.2.tar.gz",
"platform": null,
"description": "# Auto Merging Retriever Pack\n\nThis LlamaPack provides an example of our auto-merging retriever.\n\nThis specific template shows the e2e process of building this. It loads\na document, builds a hierarchical node graph (with bigger parent nodes and smaller\nchild nodes).\n\nCheck out the [notebook here](https://github.com/run-llama/llama-hub/blob/main/llama_hub/llama_packs/auto_merging_retriever/auto_merging_retriever.ipynb).\n\n## CLI Usage\n\nYou can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:\n\n```bash\nllamaindex-cli download-llamapack AutoMergingRetrieverPack --download-dir ./auto_merging_retriever_pack\n```\n\nYou can then inspect the files at `./auto_merging_retriever_pack` and use them as a template for your own project.\n\n## Code Usage\n\nYou can download the pack to a the `./auto_merging_retriever_pack` directory:\n\n```python\nfrom llama_index.core.llama_pack import download_llama_pack\n\n# download and install dependencies\nAutoMergingRetrieverPack = download_llama_pack(\n \"AutoMergingRetrieverPack\", \"./auto_merging_retriever_pack\"\n)\n```\n\nFrom here, you can use the pack, or inspect and modify the pack in `./auto_merging_retriever_pack`.\n\nThen, you can set up the pack like so:\n\n```python\n# create the pack\n# get documents from any data loader\nauto_merging_retriever_pack = AutoMergingRetrieverPack(\n documents,\n)\n```\n\nThe `run()` function is a light wrapper around `query_engine.query()`.\n\n```python\nresponse = auto_merging_retriever_pack.run(\n \"Tell me about what the author did growing up.\"\n)\n```\n\nYou can also use modules individually.\n\n```python\n# get the node parser\nnode_parser = auto_merging_retriever_pack.node_parser\n\n# get the retriever\nretriever = auto_merging_retriever_pack.retriever\n\n# get the query engine\nquery_engine = auto_merging_retriever_pack.query_engine\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index packs auto_merging_retriever integration",
"version": "0.1.2",
"project_urls": null,
"split_keywords": [
"auto",
"automerging",
"index",
"merging",
"retriever"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "32e01f97f9272aae365f40870fd1ba3c96b911f2caaadc34454418348575fa22",
"md5": "ef45fc1c4335d919ab0d62c9abf72399",
"sha256": "199a6bbbbc4d83e55a781f11936f16c2b5ba6377879fe6ba9fce67dabc93b2e3"
},
"downloads": -1,
"filename": "llama_index_packs_auto_merging_retriever-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ef45fc1c4335d919ab0d62c9abf72399",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<3.12",
"size": 3544,
"upload_time": "2024-02-13T22:53:37",
"upload_time_iso_8601": "2024-02-13T22:53:37.059909Z",
"url": "https://files.pythonhosted.org/packages/32/e0/1f97f9272aae365f40870fd1ba3c96b911f2caaadc34454418348575fa22/llama_index_packs_auto_merging_retriever-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3316deca44a6c11c4d846478f6392917045b0eadff4952343213d200fe945e11",
"md5": "acbe24beb1c57ba7339332db682fbca3",
"sha256": "937146efa0159fc21019bff0c19fc867bcdab7b552dcebd42715190d3651cb28"
},
"downloads": -1,
"filename": "llama_index_packs_auto_merging_retriever-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "acbe24beb1c57ba7339332db682fbca3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<3.12",
"size": 2936,
"upload_time": "2024-02-13T22:53:38",
"upload_time_iso_8601": "2024-02-13T22:53:38.647871Z",
"url": "https://files.pythonhosted.org/packages/33/16/deca44a6c11c4d846478f6392917045b0eadff4952343213d200fe945e11/llama_index_packs_auto_merging_retriever-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-13 22:53:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-packs-auto-merging-retriever"
}
JSON