Tutorials & Walkthroughs

Whether you’re a beginner or an experienced user, these tutorials will walk you through Haystack features and functionalities making it easy for you to understand and implement them.

Contribute

38 tutorials & walkthroughs for all levels

Full Walkthrough

Evaluation

A guided walkthrough to learn everything about evaluation

beginner
10 min
2.0

Creating Your First QA Pipeline with Retrieval-Augmentation

Build your first generative QA pipeline with OpenAI GPT models

intermediate
15 min

Creating a Generative QA Pipeline with Retrieval-Augmentation

Use a large language model in your search system through PromptNode

intermediate
15 min

Creating a Hybrid Retrieval Pipeline

Learn how to combine Retrievers to enhance retrieval

intermediate
15 min
2.0

Generating Structured Output with Loop-Based Auto-Correction

Learn how to extract structured data using an LLM, and to validate the generated output against a predefined schema.

intermediate
10 min
2.0

Building Fallbacks to Websearch with Conditional Routing

Learn how to direct the query to a web-based RAG route when necessary

advanced
20 min
2.0

Building a Chat Application with Function Calling

Learn how to build chat applications that have agent-like behavior with OpenAI function calling

beginner
10 min
2.0

Retrieving a Context Window Around a Sentence

Learn how to use the SentenceWindowRetriever to retrieve a context window

intermediate
25 min
2.0

Query Classification with TransformersTextRouter and TransformersZeroShotTextRouter

Learn how to route user questions and other text inputs with classification models

advanced
15 min

Customizing Agent to Chat with Your Documents

Advanced Customizations for Agents with Memory

beginner
5 min
2.0

Filtering Documents with Metadata

Learn how to filter down to specific documents at retrieval time using metadata

beginner
15 min
2.0

Preprocessing Different File Types

Learn how to build an indexing pipeline that will preprocess files based on their file type

beginner
10 min
2.0

Embedding Metadata for Improved Retrieval

Learn how to embed metadata while indexing, to improve the quality of retrieval results

beginner
10 min
2.0

Serializing LLM Pipelines

Learn how to serialize and deserialize your pipelines between YAML and Python

beginner
15 min

Build Your First Question Answering System

Get Started by creating a Retriever Reader pipeline.

beginner
10 min
2.0

Build an Extractive QA Pipeline

Learn how to build a Haystack pipeline that uses an extractive model to display where the answer to your query is.

beginner
20 min

Build a Scalable Question Answering System

Create a scalable Retriever Reader pipeline that uses an ElasticsearchDocumentStore.

beginner

Utilizing Existing FAQs for Question Answering

Create a smarter way to answer new questions using your existing FAQ documents.

beginner

Preprocessing Your Documents

Start converting, cleaning, and splitting Documents using Haystack’s preprocessing capabilities.

beginner

How to Use Pipelines

Learn about the many ways which you can route queries through the nodes in a pipeline.

intermediate
15 min

Fine-Tuning a Model on Your Own Data

Improve the performance of your Reader by performing fine-tuning.

intermediate

Better Retrieval with Embedding Retrieval

Use Transformer based dense Retrievers to improve your system’s performance.

intermediate
15 min
2.0

Creating a Hybrid Retrieval Pipeline

Learn how to combine keyword-based retrieval and dense retrieval to enhance retrieval

intermediate
20 min

Customizing PromptNode for NLP Tasks

Use PromptNode and PromptTemplate for your custom NLP tasks

intermediate
10 min

Answering Multihop Questions with Agents

Use Agent to answer multihop questions with extractive models

intermediate
10 min

Building a Conversational Chat App

Use ConversationalAgent to build a human-like chat application

intermediate
15 min
2.0

Classifying Documents & Queries by Language

Learn how to classify documents and route queries by language, for both indexing and RAG pipelines

intermediate

Question Generation

Generate a set of questions that can be answered by a given Document.

intermediate
15 min
2.0

Evaluating RAG Pipelines

Learn how to evaluate your RAG pipelines using statistical and model-based evaluation metrics

intermediate

Query Classifier

Classify incoming queries so that they can be routed to the nodes that are best at handling them.

Outdated
intermediate
10 min
2.0

Simplifying Pipeline Inputs with Multiplexer

Learn how to declutter the inputs of complex pipelines

intermediate

Document Classification at Index Time

Generate and attach classification labels to your Documents when indexing.

intermediate
20 min

Text-To-Image Search Pipeline with Multimodal Retriever

Use a MultiModalRetriever to build a cross-modal search pipeline.

advanced

Evaluation of a QA System

Learn how to evaluate the performance of individual nodes as well as entire pipelines.

advanced

Training Your Own Dense Passage Retrieval Model

Learn about training a Dense Passage Retrieval model and the data needed to do so.

advanced
30 min

Using Haystack with REST API

Create a production-ready pipeline and interact with Haystack REST API.

advanced

Open-Domain QA on Tables

Perform question answering on tabular data.

advanced

Generative Pseudo Labeling for Domain Adaptation

Use a Retriever and a query generator to perform unsupervised domain adaptation.

Looking for a tutorial?

Type a keyword then click the "Search" button and we'll search through all tutorials.

No results found

You may want to try different keywords or check for any possible typos.

There has been an error.

Please try again later.

Searching..