# Sentence Window Retriever
This LlamaPack provides an example of our sentence window retriever.
This specific template shows the e2e process of building this. It loads
a document, chunks it up, adds surrounding context as metadata to each chunk,
and during retrieval inserts the context back into each chunk for response synthesis.
Check out the [notebook here](https://github.com/run-llama/llama-hub/blob/main/llama_hub/llama_packs/sentence_window_retriever/sentence_window.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 SentenceWindowRetrieverPack --download-dir ./sentence_window_retriever_pack
```
You can then inspect the files at `./sentence_window_retriever_pack` and use them as a template for your own project.
## Code Usage
You can download the pack to a the `./sentence_window_retriever_pack` directory:
```python
from llama_index.core.llama_pack import download_llama_pack
# download and install dependencies
SentenceWindowRetrieverPack = download_llama_pack(
"SentenceWindowRetrieverPack", "./sentence_window_retriever_pack"
)
```
From here, you can use the pack, or inspect and modify the pack in `./sentence_window_retriever_pack`.
Then, you can set up the pack like so:
```python
# create the pack
# get documents from any data loader
sentence_window_retriever_pack = SentenceWindowRetrieverPack(
documents,
)
```
The `run()` function is a light wrapper around `query_engine.query()`.
```python
response = sentence_window_retriever_pack.run(
"Tell me a bout a Music celebritiy."
)
```
You can also use modules individually.
```python
# get the sentence vector index
index = sentence_window_retriever_pack.sentence_index
# get the node parser
node_parser = sentence_window_retriever_pack.node_parser
# get the metadata replacement postprocessor
postprocessor = sentence_window_retriever_pack.postprocessor
# get the query engine
query_engine = sentence_window_retriever_pack.query_engine
```
Raw data
{
"_id": null,
"home_page": "",
"name": "llama-index-packs-sentence-window-retriever",
"maintainer": "jerryjliu",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0",
"maintainer_email": "",
"keywords": "retriever,sentence,window",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/13/c1/fae9d1a90054f38cab2aeb9a5c66d75297621daefdeb1040683141cc4694/llama_index_packs_sentence_window_retriever-0.1.3.tar.gz",
"platform": null,
"description": "# Sentence Window Retriever\n\nThis LlamaPack provides an example of our sentence window retriever.\n\nThis specific template shows the e2e process of building this. It loads\na document, chunks it up, adds surrounding context as metadata to each chunk,\nand during retrieval inserts the context back into each chunk for response synthesis.\n\nCheck out the [notebook here](https://github.com/run-llama/llama-hub/blob/main/llama_hub/llama_packs/sentence_window_retriever/sentence_window.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 SentenceWindowRetrieverPack --download-dir ./sentence_window_retriever_pack\n```\n\nYou can then inspect the files at `./sentence_window_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 `./sentence_window_retriever_pack` directory:\n\n```python\nfrom llama_index.core.llama_pack import download_llama_pack\n\n# download and install dependencies\nSentenceWindowRetrieverPack = download_llama_pack(\n \"SentenceWindowRetrieverPack\", \"./sentence_window_retriever_pack\"\n)\n```\n\nFrom here, you can use the pack, or inspect and modify the pack in `./sentence_window_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\nsentence_window_retriever_pack = SentenceWindowRetrieverPack(\n documents,\n)\n```\n\nThe `run()` function is a light wrapper around `query_engine.query()`.\n\n```python\nresponse = sentence_window_retriever_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 sentence vector index\nindex = sentence_window_retriever_pack.sentence_index\n\n# get the node parser\nnode_parser = sentence_window_retriever_pack.node_parser\n\n# get the metadata replacement postprocessor\npostprocessor = sentence_window_retriever_pack.postprocessor\n\n# get the query engine\nquery_engine = sentence_window_retriever_pack.query_engine\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index packs sentence_window_retriever integration",
"version": "0.1.3",
"project_urls": null,
"split_keywords": [
"retriever",
"sentence",
"window"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "727b3d72eaee474f804054080d0be6689889de8a9f6a91b7f1115e3866530f15",
"md5": "db5ce36a8324a8d0f00ad584dc6fef9c",
"sha256": "6efa621ef11db89f35d46d9c2f762635148769546ada50777a0a26f16d57983d"
},
"downloads": -1,
"filename": "llama_index_packs_sentence_window_retriever-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "db5ce36a8324a8d0f00ad584dc6fef9c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0",
"size": 3540,
"upload_time": "2024-02-22T01:37:47",
"upload_time_iso_8601": "2024-02-22T01:37:47.895174Z",
"url": "https://files.pythonhosted.org/packages/72/7b/3d72eaee474f804054080d0be6689889de8a9f6a91b7f1115e3866530f15/llama_index_packs_sentence_window_retriever-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "13c1fae9d1a90054f38cab2aeb9a5c66d75297621daefdeb1040683141cc4694",
"md5": "26954c8a0f27d0c87c616bf3ead03a7f",
"sha256": "82d11834e29d19bde84cc154268529d50ae9915ae843db75feb20888b9cd6d18"
},
"downloads": -1,
"filename": "llama_index_packs_sentence_window_retriever-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "26954c8a0f27d0c87c616bf3ead03a7f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0",
"size": 3125,
"upload_time": "2024-02-22T01:37:48",
"upload_time_iso_8601": "2024-02-22T01:37:48.923610Z",
"url": "https://files.pythonhosted.org/packages/13/c1/fae9d1a90054f38cab2aeb9a5c66d75297621daefdeb1040683141cc4694/llama_index_packs_sentence_window_retriever-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-22 01:37:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-packs-sentence-window-retriever"
}
JSON