Adding sentence window retriever (#357)

davidsbatista · TuanaCelik · web-flow · commit 264a88827a06 · 2024-10-21T10:58:30.000+02:00
* initial import

* updating README.MD

* updating README.MD

* adding notebook

* updating README.MD

* trying bash

* fixing data fetch

---------

Co-authored-by: Tuana Celik &lt;tuana.celik@deepset.ai&gt;
diff --git a/.gitignore b/.gitignore
@@ -137,4 +137,4 @@ dmypy.json
 text/**
 
 tutorials/data
-saved_models
+saved_models
diff --git a/README.md b/README.md
@@ -48,7 +48,7 @@ Haystack 2.0
 | [[OUTDATED] Seq2SeqGenerator](./tutorials/12_LFQA.ipynb)                                                  | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/12_LFQA.ipynb)                                                    | [Embedding Metadata for Improved Retrieval](./tutorials/39_Embedding_Metadata_for_Improved_Retrieval.ipynb)      | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/39_Embedding_Metadata_for_Improved_Retrieval.ipynb)|
 | [Question Generation](./tutorials/13_Question_generation.ipynb)                                           | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/13_Question_generation.ipynb)                                     | [Building a Chat Application with Function Calling](./tutorials/40_Building_Chat_Application_with_Function_Calling.ipynb)| [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/40_Building_Chat_Application_with_Function_Calling.ipynb)|
 | [Query Classifier](./tutorials/14_Query_Classifier.ipynb)                                                 | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/14_Query_Classifier.ipynb)                                        | [Query Classification with TransformersTextRouter](./tutorials/41_Query_Classification_with_TransformersTextRouter_and_TransformersZeroShotTextRouter.ipynb)| [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/41_Query_Classification_with_TransformersTextRouter_and_TransformersZeroShotTextRouter.ipynb)                                                                                                                                          |
-| [Table QA](./tutorials/15_TableQA.ipynb)                                                                  | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/15_TableQA.ipynb)                                                 |                                                                                                                  |                                                                                                                                                                                                                          |
+| [Table QA](./tutorials/15_TableQA.ipynb)                                                                  | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/15_TableQA.ipynb)                                                 |    [Retrieving a Context Window Around a Sentence](./tutorials/42_Sentence_Window_Retriever.ipynb)                                                                  | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/42_Sentence_Window_Retriever.ipynb) |                                                                                                                                                                                                                          |
 | [Document Classifier at Index Time](./tutorials/16_Document_Classifier_at_Index_Time.ipynb)               | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/16_Document_Classifier_at_Index_Time.ipynb)                       |                                                                                                                  |                                                                                                                                                                                                                          |
 | [Make Your QA Pipelines Talk!](./tutorials/17_Audio.ipynb)                                                | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/17_Audio.ipynb)                                                   |                                                                                                                  |                                                                                                                                                                                                                          |
 | [Generative Pseudo Labeling](./tutorials/18_GPL.ipynb)                                                    | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/18_GPL.ipynb)                                                     |                                                                                                                  |                                                                                                                                                                                                                          |
@@ -59,4 +59,4 @@ Haystack 2.0
 | [Answering Complex Questions with Agents](./tutorials/23_Answering_Multihop_Questions_with_Agents.ipynb)  | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/23_Answering_Multihop_Questions_with_Agents.ipynb)                |                                                                                                                  |                                                                                                                                                                                                                          |
 | [Building a Conversational Chat App](./tutorials/24_Building_Chat_App.ipynb)                              | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/24_Building_Chat_App.ipynb)                                       |                                                                                                                  |                                                                                                                                                                                                                          |
 | [Customizing Agent to Chat with Your Documents](./tutorials/25_Customizing_Agent.ipynb)                   | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/25_Customizing_Agent.ipynb)                                       |                                                                                                                  |                                                                                                                                                                                                                          |
-| [Creating a Hybrid Retrieval Pipeline](./tutorials/26_Hybrid_Retrieval.ipynb)                             | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/26_Hybrid_Retrieval.ipynb)                                        |                                                                                                                  |                                                                                                                                                                                                                          |
+| [Creating a Hybrid Retrieval Pipeline](./tutorials/26_Hybrid_Retrieval.ipynb)                             | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/26_Hybrid_Retrieval.ipynb)                                        |                                                                                                                  |                                                                                                                                                                                                                          |
diff --git a/index.toml b/index.toml
@@ -454,6 +454,19 @@ haystack_2 = true
 dependencies = ["sentence-transformers>=3.0.0", "gradio", "torch", "sentencepiece", "datasets", "accelerate"]
 featured = true
 
+[[tutorial]]
+title = "Retrieving a Context Window Around a Sentence"
+description = "Learn how to use the SentenceWindowRetriever to retrieve a context window"
+level = "beginner"
+weight = 105
+notebook = "42_Sentence_Window_Retriever.ipynb"
+aliases = []
+completion_time = "10 min"
+created_at = 2024-10-16
+haystack_2 = true
+dependencies = []
+featured = true
+
 [[tutorial]]
 title = "Evaluation"
 description = "A guided walkthrough to learn everything about evaluation"
diff --git a/tutorials/42_Sentence_Window_Retriever.ipynb b/tutorials/42_Sentence_Window_Retriever.ipynb
