haystack-tutorials

1
[config]
2
layout = "tutorial"
3
toc = true 
4
colab = "https://colab.research.google.com/github/deepset-ai/haystack-tutorials/blob/main/tutorials/"
5

6
[[tutorial]]
7
title = "Build Your First Question Answering System"
8
description = "Get Started by creating a Retriever Reader pipeline."
9
level = "beginner"
10
weight = 10
11
notebook = "01_Basic_QA_Pipeline.ipynb"
12
aliases = ["first-qa-system", "without-elasticsearch", "03_basic_qa_pipeline_without_elasticsearch"]
13
completion_time = "15 min"
14
created_at = 2023-01-11
15

16
[[tutorial]]
17
title = "Fine-Tuning a Model on Your Own Data"
18
description = "Improve the performance of your Reader by performing fine-tuning."
19
level = "intermediate"
20
weight = 50
21
notebook = "02_Finetune_a_model_on_your_data.ipynb"
22
aliases = ["fine-tuning-a-model"]
23
created_at = 2021-08-12
24
completion_time = "15 min"
25
needs_gpu = true
26

27
[[tutorial]]
28
title = "Build a Scalable Question Answering System"
29
description = "Create a scalable Retriever Reader pipeline that uses an ElasticsearchDocumentStore."
30
level = "beginner"
31
weight = 15
32
notebook = "03_Scalable_QA_System.ipynb"
33
aliases = []
34
completion_time = "20 min"
35
created_at = 2023-01-11
36

37
[[tutorial]]
38
title = "Utilizing Existing FAQs for Question Answering"
39
description = "Create a smarter way to answer new questions using your existing FAQ documents."
40
level = "beginner"
41
weight = 20
42
notebook = "04_FAQ_style_QA.ipynb"
43
aliases = ["existing-faqs"]
44
created_at = 2021-08-12
45

46
[[tutorial]]
47
title = "Evaluation of a QA System"
48
description = "Learn how to evaluate the performance of individual nodes as well as entire pipelines."
49
level = "advanced"
50
weight = 105
51
notebook = "05_Evaluation.ipynb"
52
aliases = ["evaluation"]
53
created_at = 2021-08-12
54

55
[[tutorial]]
56
title = "Better Retrieval with Embedding Retrieval"
57
description = "Use Transformer based dense Retrievers to improve your system’s performance."
58
level = "intermediate"
59
weight = 55
60
notebook = "06_Better_Retrieval_via_Embedding_Retrieval.ipynb"
61
aliases = ["embedding-retrieval"]
62
created_at = 2022-03-08
63

64
[[tutorial]]
65
title = "Generative QA with RAGenerator"
66
description = "Try out a generative model in place of the extractive Reader."
67
level = "intermediate"
68
weight = 60
69
notebook = "07_RAG_Generator.ipynb"
70
aliases = []
71
created_at = 2021-08-12
72
haystack_version = "1.17.2"
73
hidden = true
74
sitemap_exclude = true
75

76
[[tutorial]]
77
title = "Preprocessing Your Documents"
78
description = "Start converting, cleaning, and splitting Documents using Haystack’s preprocessing capabilities."
79
level = "beginner"
80
weight = 25
81
notebook = "08_Preprocessing.ipynb"
82
aliases = ["preprocessing"]
83
created_at = 2021-08-12
84

85
[[tutorial]]
86
title = "Training Your Own Dense Passage Retrieval Model"
87
description = "Learn about training a Dense Passage Retrieval model and the data needed to do so."
88
level = "advanced"
89
weight = 110
90
notebook = "09_DPR_training.ipynb"
91
aliases = ["train-dpr"]
92
created_at = 2021-08-12
93
needs_gpu = true
94

95
[[tutorial]]
96
title = "Question Answering on a Knowledge Graph"
97
description = "Experiment with a question answering system that draws upon knowledge graph.h"
98
level = "advanced"
99
weight = 120
100
notebook = "10_Knowledge_Graph.ipynb"
101
aliases = ["knowledge-graph"]
102
created_at = 2021-08-12
103
haystack_version = "1.16.1"
104
hidden = true
105
sitemap_exclude = true
106

107
[[tutorial]]
108
title = "How to Use Pipelines"
109
description = "Learn about the many ways which you can route queries through the nodes in a pipeline."
110
level = "beginner"
111
weight = 40
112
notebook = "11_Pipelines.ipynb"
113
aliases = ["pipelines"]
114
created_at = 2021-08-12
115

116
[[tutorial]]
117
title = "Generative QA with Seq2SeqGenerator"
118
description = "Try out a generative model in place of the extractive Reader."
119
level = "intermediate"
120
weight = 70
121
notebook = "12_LFQA.ipynb"
122
aliases = ["lfqa"]
123
created_at = 2021-08-12
124
haystack_version = "1.17.2"
125
hidden = true
126
sitemap_exclude = true
127

128
[[tutorial]]
129
title = "Question Generation"
130
description = "Generate a set of questions that can be answered by a given Document."
131
level = "intermediate"
132
weight = 75
133
notebook = "13_Question_generation.ipynb"
134
aliases = ["question-generation"]
135
created_at = 2021-08-12
136
needs_gpu = true
137

138
[[tutorial]]
139
title = "Query Classifier"
140
description = "Classify incoming queries so that they can be routed to the nodes that are best at handling them."
141
level = "intermediate"
142
weight = 80
143
notebook = "14_Query_Classifier.ipynb"
144
aliases = ["query-classifier"]
145
created_at = 2021-08-12
146

147
[[tutorial]]
148
title = "Open-Domain QA on Tables"
149
description = "Perform question answering on tabular data."
150
level = "advanced"
151
weight = 130
152
notebook = "15_TableQA.ipynb"
153
aliases = ["table-qa"]
154
created_at = 2021-08-12
155

156
[[tutorial]]
157
title = "Document Classification at Index Time"
158
description = "Generate and attach classification labels to your Documents when indexing."
159
level = "intermediate"
160
weight = 85
161
notebook = "16_Document_Classifier_at_Index_Time.ipynb"
162
aliases = ["doc-class-index"]
163
created_at = 2021-08-12
164

165
[[tutorial]]
166
title = "Make Your QA Pipelines Talk!"
167
description = "Convert text Answers into speech."
168
level = "intermediate"
169
weight = 90
170
notebook = "17_Audio.ipynb"
171
aliases = ["audio"]
172
created_at = 2022-06-07
173

174
[[tutorial]]
175
title = "Generative Pseudo Labeling for Domain Adaptation"
176
description = "Use a Retriever and a query generator to perform unsupervised domain adaptation."
177
level = "advanced"
178
weight = 140
179
notebook = "18_GPL.ipynb"
180
aliases = ["gpl"]
181
created_at = 2022-06-07
182
needs_gpu = true
183

184
[[tutorial]]
185
title = "Text-To-Image Search Pipeline with Multimodal Retriever"
186
description = "Use a MultiModalRetriever to build a cross-modal search pipeline."
187
level = "intermediate"
188
weight = 95
189
notebook = "19_Text_to_Image_search_pipeline_with_MultiModal_Retriever.ipynb"
190
aliases = ["multimodal"]
191
completion_time = "20 min"
192
created_at = 2022-07-11
193

194
[[tutorial]]
195
title = "Using Haystack with REST API"
196
description = "Create a production-ready pipeline and interact with Haystack REST API."
197
level = "advanced"
198
weight = 115
199
notebook = "20_Using_Haystack_with_REST_API.ipynb"
200
aliases = ["using-haystack-with-rest-api"]
201
colab = false
202
completion_time = "30 min"
203
created_at = 2023-01-11
204

205
[[tutorial]]
206
title = "Customizing PromptNode for NLP Tasks"
207
description = "Use PromptNode and PromptTemplate for your custom NLP tasks"
208
level = "intermediate"
209
weight = 57
210
notebook = "21_Customizing_PromptNode.ipynb"
211
aliases = ["customizing-promptnode"]
212
completion_time = "20 min"
213
created_at = 2023-02-16
214

215
[[tutorial]]
216
title = "Answering Multihop Questions with Agents"
217
description = "Use Agent to answer multihop questions with extractive models"
218
level = "intermediate"
219
weight = 63
220
notebook = "23_Answering_Multihop_Questions_with_Agents.ipynb"
221
aliases = ["multihop-qa-with-agents"]
222
completion_time = "10 min"
223
created_at = 2023-03-27
224

225
[[tutorial]]
226
title = "Creating a Generative QA Pipeline with Retrieval-Augmentation"
227
description = "Use a large language model in your search system through PromptNode"
228
level = "intermediate"
229
weight = 61
230
notebook = "22_Pipeline_with_PromptNode.ipynb"
231
aliases = ["pipeline-with-promptnode", "retrieval-augmented-generation"]
232
completion_time = "15 min"
233
created_at = 2023-03-13
234
featured = true
235

236
[[tutorial]]
237
title = "Building a Conversational Chat App"
238
description = "Use ConversationalAgent to build a human-like chat application"
239
level = "intermediate"
240
weight = 64
241
notebook = "24_Building_Chat_App.ipynb"
242
aliases = ["building-chat-app"]
243
completion_time = "10 min"
244
created_at = 2023-05-30
245

246
[[tutorial]]
247
title = "Customizing Agent to Chat with Your Documents"
248
description = "Advanced Customizations for Agents with Memory"
249
level = "advanced"
250
weight = 117
251
notebook = "25_Customizing_Agent.ipynb"
252
aliases = ["customizing-agent"]
253
completion_time = "15 min"
254
created_at = 2023-07-19
255
featured = true
256

257
[[tutorial]]
258
title = "Creating a Hybrid Retrieval Pipeline"
259
description = "Learn how to combine Retrievers to enhance retrieval"
260
level = "intermediate"
261
weight = 63
262
notebook = "26_Hybrid_Retrieval.ipynb"
263
aliases = ["hybrid-retrieval"]
264
completion_time = "15 min"
265
created_at = 2023-10-10
266
featured = true
267

268
[[tutorial]]
269
title = "Creating Your First QA Pipeline with Retrieval-Augmentation"
270
description = "Build your first generative QA pipeline with OpenAI GPT models"
271
level = "beginner"
272
weight = 5
273
notebook = "27_First_RAG_Pipeline.ipynb"
274
aliases = []
275
completion_time = "10 min"
276
created_at = 2023-12-05
277
haystack_2 = true
278
featured = true
279

280
[[tutorial]]
281
title = "Generating Structured Output with Loop-Based Auto-Correction"
282
description = "Learn how to extract structured data using an LLM, and to validate the generated output against a predefined schema."
283
level = "intermediate"
284
weight = 71
285
notebook = "28_Structured_Output_With_Loop.ipynb"
286
aliases = []
287
completion_time = "15 min"
288
created_at = 2023-11-30
289
haystack_2 = true
290
featured = true
291

292
[[tutorial]]
293
title = "Serializing LLM Pipelines"
294
description = "Learn how to serialize and deserialize your pipelines between YAML and Python"
295
level = "beginner"
296
weight = 9
297
notebook = "29_Serializing_Pipelines.ipynb"
298
aliases = []
299
completion_time = "10 min"
300
created_at = 2024-01-29
301
haystack_2 = true
302

303
[[tutorial]]
304
title = "Preprocessing Different File Types"
305
description = "Learn how to build an indexing pipeline that will preprocess files based on their file type"
306
level = "beginner"
307
weight = 7
308
notebook = "30_File_Type_Preprocessing_Index_Pipeline.ipynb"
309
aliases = []
310
completion_time = "15 min"
311
created_at = 2024-01-30
312
haystack_2 = true
313

314
[[tutorial]]
315
title = "Filtering Documents with Metadata"
316
description = "Learn how to filter down to specific documents at retrieval time using metadata"
317
level = "beginner"
318
weight = 6
319
notebook = "31_Metadata_Filtering.ipynb"
320
aliases = []
321
completion_time = "5 min"
322
created_at = 2024-01-30
323
haystack_2 = true
324

325
[[tutorial]]
326
title = "Classifying Documents & Queries by Language"
327
description = "Learn how to classify documents and route queries by language, for both indexing and RAG pipelines"
328
level = "intermediate"
329
weight = 75
330
notebook = "32_Classifying_Documents_and_Queries_by_Language.ipynb"
331
aliases = []
332
completion_time = "15 min"
333
created_at = 2024-02-06
334
haystack_2 = true
335

336
[[tutorial]]
337
title = "Creating a Hybrid Retrieval Pipeline"
338
description = "Learn how to combine keyword-based retrieval and dense retrieval to enhance retrieval"
339
level = "intermediate"
340
weight = 56
341
notebook = "33_Hybrid_Retrieval.ipynb"
342
aliases = []
343
completion_time = "15 min"
344
created_at = 2024-02-13
345
haystack_2 = true
346

347
[[tutorial]]
348
title = "Build an Extractive QA Pipeline"
349
description = "Learn how to build a Haystack pipeline that uses an extractive model to display where the answer to your query is."
350
level = "beginner"
351
weight = 15
352
notebook = "34_Extractive_QA_Pipeline.ipynb"
353
aliases = []
354
completion_time = "10 min"
355
created_at = 2024-02-09
356
haystack_2 = true
357

358
[[tutorial]]
359
title = "Model-Based Evaluation of RAG Pipelines"
360
description = "Learn how to evaluate your RAG pipelines using some of the model-based evaluation frameworkes integerated into Haystack"
361
level = "intermediate"
362
weight = 77
363
notebook = "35_Model_Based_Evaluation_of_RAG_Pipelines.ipynb"
364
aliases = []
365
completion_time = "15 min"
366
created_at = 2024-02-12
367
haystack_2 = true
368

369
[[tutorial]]
370
title = "Building Fallbacks to Websearch with Conditional Routing"
371
description = "Learn how to direct the query to a web-based RAG route when necessary"
372
level = "intermediate"
373
weight = 81
374
notebook = "36_Building_Fallbacks_with_Conditional_Routing.ipynb"
375
aliases = []
376
completion_time = "10 min"
377
created_at = 2024-02-16
378
haystack_2 = true
379
featured = true
380

381
[[tutorial]]
382
title = "Simplifying Pipeline Inputs with Multiplexer"
383
description = "Learn how to declutter the inputs of complex pipelines"
384
level = "intermediate"
385
weight = 84
386
notebook = "37_Simplifying_Pipeline_Inputs_with_Multiplexer.ipynb"
387
aliases = []
388
completion_time = "10 min"
389
created_at = 2024-02-19
390
haystack_2 = true
391

392
[[tutorial]]
393
title = "Embedding Metadata for Improved Retrieval"
394
description = "Learn how to embed metadata while indexing, to improve the quality of retrieval results"
395
level = "beginner"
396
weight = 8
397
notebook = "39_Embedding_Metadata_for_Improved_Retrieval.ipynb"
398
aliases = []
399
completion_time = "10 min"
400
created_at = 2024-02-20
401
haystack_2 = true
402

403
[[tutorial]]
404
title = "Building a Chat Application with Function Calling"
405
description = "Learn how to build chat applications that have agent-like behavior with OpenAI function calling"
406
level = "advanced"
407
weight = 100
408
notebook = "40_Building_Chat_Application_with_Function_Calling.ipynb"
409
aliases = []
410
completion_time = "20 min"
411
created_at = 2024-03-05
412
haystack_2 = true
413
featured = true
414