# Recursive Retriever Packs
## Embedded Tables Retriever Pack w/ Unstructured.io
This LlamaPack provides an example of our embedded tables 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/recursive_retriever/embedded_tables_unstructured/embedded_tables.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 EmbeddedTablesUnstructuredRetrieverPack --download-dir ./embedded_tables_unstructured_pack
```
You can then inspect the files at `./embedded_tables_unstructured_pack` and use them as a template for your own project.
### Code Usage
You can download the pack to a the `./embedded_tables_unstructured_pack` directory:
```python
from llama_index.core.llama_pack import download_llama_pack
# download and install dependencies
EmbeddedTablesUnstructuredRetrieverPack = download_llama_pack(
"EmbeddedTablesUnstructuredRetrieverPack",
"./embedded_tables_unstructured_pack",
)
```
From here, you can use the pack, or inspect and modify the pack in `./embedded_tables_unstructured_pack`.
Then, you can set up the pack like so:
```python
# create the pack
# get documents from any data loader
embedded_tables_unstructured_pack = EmbeddedTablesUnstructuredRetrieverPack(
"tesla_2021_10k.htm",
)
```
The `run()` function is a light wrapper around `query_engine.query()`.
```python
response = embedded_tables_unstructured_pack.run(
"What was the revenue in 2020?"
)
```
You can also use modules individually.
```python
# get the node parser
node_parser = embedded_tables_unstructured_pack.node_parser
# get the retriever
retriever = embedded_tables_unstructured_pack.recursive_retriever
# get the query engine
query_engine = embedded_tables_unstructured_pack.query_engine
```
## Recursive Retriever - Small-to-big retrieval
This LlamaPack provides an example of our recursive retriever (small-to-big).
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/recursive_retriever/small_to_big/small_to_big.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 RecursiveRetrieverSmallToBigPack --download-dir ./recursive_retriever_stb_pack
```
You can then inspect the files at `./recursive_retriever_stb_pack` and use them as a template for your own project.
### Code Usage
You can download the pack to a the `./recursive_retriever_stb_pack` directory:
```python
from llama_index.core.llama_pack import download_llama_pack
# download and install dependencies
RecursiveRetrieverSmallToBigPack = download_llama_pack(
"RecursiveRetrieverSmallToBigPack", "./recursive_retriever_stb_pack"
)
```
From here, you can use the pack, or inspect and modify the pack in `./recursive_retriever_stb_pack`.
Then, you can set up the pack like so:
```python
# create the pack
# get documents from any data loader
recursive_retriever_stb_pack = RecursiveRetrieverSmallToBigPack(
documents,
)
```
The `run()` function is a light wrapper around `query_engine.query()`.
```python
response = recursive_retriever_stb_pack.run(
"Tell me a bout a Music celebritiy."
)
```
You can also use modules individually.
```python
# get the recursive retriever
recursive_retriever = recursive_retriever_stb_pack.recursive_retriever
# get the query engine
query_engine = recursive_retriever_stb_pack.query_engine
```
Raw data
{
"_id": null,
"home_page": "",
"name": "llama-index-packs-recursive-retriever",
"maintainer": "jerryjliu",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0",
"maintainer_email": "",
"keywords": "big,embedded,recursive,retriever,small,tables,unstructured",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/4b/db/c8afaf99f3ffed0e4e913ecec57c314d035e352e928a75eda33eadd2fbf7/llama_index_packs_recursive_retriever-0.1.3.tar.gz",
"platform": null,
"description": "# Recursive Retriever Packs\n\n## Embedded Tables Retriever Pack w/ Unstructured.io\n\nThis LlamaPack provides an example of our embedded tables 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/recursive_retriever/embedded_tables_unstructured/embedded_tables.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 EmbeddedTablesUnstructuredRetrieverPack --download-dir ./embedded_tables_unstructured_pack\n```\n\nYou can then inspect the files at `./embedded_tables_unstructured_pack` and use them as a template for your own project.\n\n### Code Usage\n\nYou can download the pack to a the `./embedded_tables_unstructured_pack` directory:\n\n```python\nfrom llama_index.core.llama_pack import download_llama_pack\n\n# download and install dependencies\nEmbeddedTablesUnstructuredRetrieverPack = download_llama_pack(\n \"EmbeddedTablesUnstructuredRetrieverPack\",\n \"./embedded_tables_unstructured_pack\",\n)\n```\n\nFrom here, you can use the pack, or inspect and modify the pack in `./embedded_tables_unstructured_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\nembedded_tables_unstructured_pack = EmbeddedTablesUnstructuredRetrieverPack(\n \"tesla_2021_10k.htm\",\n)\n```\n\nThe `run()` function is a light wrapper around `query_engine.query()`.\n\n```python\nresponse = embedded_tables_unstructured_pack.run(\n \"What was the revenue in 2020?\"\n)\n```\n\nYou can also use modules individually.\n\n```python\n# get the node parser\nnode_parser = embedded_tables_unstructured_pack.node_parser\n\n# get the retriever\nretriever = embedded_tables_unstructured_pack.recursive_retriever\n\n# get the query engine\nquery_engine = embedded_tables_unstructured_pack.query_engine\n```\n\n## Recursive Retriever - Small-to-big retrieval\n\nThis LlamaPack provides an example of our recursive retriever (small-to-big).\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/recursive_retriever/small_to_big/small_to_big.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 RecursiveRetrieverSmallToBigPack --download-dir ./recursive_retriever_stb_pack\n```\n\nYou can then inspect the files at `./recursive_retriever_stb_pack` and use them as a template for your own project.\n\n### Code Usage\n\nYou can download the pack to a the `./recursive_retriever_stb_pack` directory:\n\n```python\nfrom llama_index.core.llama_pack import download_llama_pack\n\n# download and install dependencies\nRecursiveRetrieverSmallToBigPack = download_llama_pack(\n \"RecursiveRetrieverSmallToBigPack\", \"./recursive_retriever_stb_pack\"\n)\n```\n\nFrom here, you can use the pack, or inspect and modify the pack in `./recursive_retriever_stb_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\nrecursive_retriever_stb_pack = RecursiveRetrieverSmallToBigPack(\n documents,\n)\n```\n\nThe `run()` function is a light wrapper around `query_engine.query()`.\n\n```python\nresponse = recursive_retriever_stb_pack.run(\n \"Tell me a bout a Music celebritiy.\"\n)\n```\n\nYou can also use modules individually.\n\n```python\n# get the recursive retriever\nrecursive_retriever = recursive_retriever_stb_pack.recursive_retriever\n\n# get the query engine\nquery_engine = recursive_retriever_stb_pack.query_engine\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index packs recursive_retriever integration",
"version": "0.1.3",
"project_urls": null,
"split_keywords": [
"big",
"embedded",
"recursive",
"retriever",
"small",
"tables",
"unstructured"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2c84757d2001804232413decb0d94b02c67cde5d13e17fabb6faba204d048ebf",
"md5": "cc5440e451b0838cca3cb7d9b7a48b58",
"sha256": "e2b7de585493452c80edefd47314add224e8f01d1555921a4e2e402a02cf4be8"
},
"downloads": -1,
"filename": "llama_index_packs_recursive_retriever-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cc5440e451b0838cca3cb7d9b7a48b58",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0",
"size": 5676,
"upload_time": "2024-02-22T01:32:26",
"upload_time_iso_8601": "2024-02-22T01:32:26.271745Z",
"url": "https://files.pythonhosted.org/packages/2c/84/757d2001804232413decb0d94b02c67cde5d13e17fabb6faba204d048ebf/llama_index_packs_recursive_retriever-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4bdbc8afaf99f3ffed0e4e913ecec57c314d035e352e928a75eda33eadd2fbf7",
"md5": "4d6d73947b96f8a87e86db9396a59b1f",
"sha256": "90577ff52204e74d16aaf4034ad10355e34aee52ae0a1d1d03d8726c1feb7f82"
},
"downloads": -1,
"filename": "llama_index_packs_recursive_retriever-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "4d6d73947b96f8a87e86db9396a59b1f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0",
"size": 4251,
"upload_time": "2024-02-22T01:32:27",
"upload_time_iso_8601": "2024-02-22T01:32:27.368590Z",
"url": "https://files.pythonhosted.org/packages/4b/db/c8afaf99f3ffed0e4e913ecec57c314d035e352e928a75eda33eadd2fbf7/llama_index_packs_recursive_retriever-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-22 01:32:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-packs-recursive-retriever"
}
JSON