llama-index packs auto_merging_retriever integration
Project description
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.
CLI Usage
You can download llamapacks directly using llamaindex-cli
, which comes installed with the llama-index
python package:
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:
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:
# 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()
.
response = auto_merging_retriever_pack.run(
"Tell me about what the author did growing up."
)
You can also use modules individually.
# 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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for llama_index_packs_auto_merging_retriever-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bfd2a516f112118da266f6c6b02f407f9476625f2abd9b51d0b2f387c45ffa7b |
|
MD5 | 4f5167d66489f014c5849e05f90999d2 |
|
BLAKE2b-256 | 2dadc7f78f59560cfbe0fba8b3cb2101b25abde1183e7bff074021a46d4ac473 |
Hashes for llama_index_packs_auto_merging_retriever-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f54933a9fccc2a2e5448b08ea552788429ba5915ca5ff57be60e88317e2efb36 |
|
MD5 | a091d25b8c5b27942c2f8fcb6a42b5f6 |
|
BLAKE2b-256 | af890fe8cd7b543ce4d595ff1bde621272417eeccd6b6e1cc20f84bc04fbe628 |