Build RAG Chatbot with Haystack, OpenSearch, OpenAI GPT-4o, and OpenAI text-embedding-3-small

Introduction to RAG

Retrieval-Augmented Generation (RAG) is a game-changer for GenAI applications, especially in conversational AI. It combines the power of pre-trained large language models (LLMs) like OpenAI’s GPT with external knowledge sources stored in vector databases such as Milvus and Zilliz Cloud, allowing for more accurate, contextually relevant, and up-to-date response generation. A RAG pipeline usually consists of four basic components: a vector database, an embedding model, an LLM, and a framework.

Key Components We'll Use for This RAG Chatbot

This tutorial shows you how to build a simple RAG chatbot in Python using the following components:

Haystack: An open-source Python framework designed for building production-ready NLP applications, particularly question answering and semantic search systems. Haystack excels at retrieving information from large document collections through its modular architecture that combines retrieval and reader components. Ideal for developers creating search applications, chatbots, and knowledge management systems that require efficient document processing and accurate information extraction from unstructured text.
OpenSearch: An open-source search and analytics suite derived from Elasticsearch. It offers robust full-text search and real-time analytics, with vector search available as an add-on for similarity-based queries, extending its capabilities to handle high-dimensional data. Since it is just a vector search add-on rather than a purpose-built vector database, it lacks scalability and availability and many other advanced features required by enterprise-level applications. Therefore, if you prefer a much more scalable solution or hate to manage your own infrastructure, we recommend using Zilliz Cloud, which is a fully managed vector database service built on the open-source Milvus and offers a free tier supporting up to 1 million vectors.)
OpenAI GPT-4o: A multimodal AI model optimized for advanced natural language processing, image understanding, and audio analysis. It excels in real-time interactions, offering high accuracy, contextual awareness, and seamless integration across diverse inputs. Ideal for dynamic applications like interactive customer support, content generation, multilingual translation, and complex data synthesis in industries requiring rapid, adaptive AI solutions.
OpenAI text-embedding-3-small: Designed to generate dense vector representations of text, this model excels in efficiency and cost-effectiveness, optimized for speed and low resource usage. It delivers competitive performance in semantic similarity, retrieval, and clustering tasks, making it ideal for large-scale applications like search engines, recommendation systems, and text classification where balancing accuracy with computational cost is crucial.

By the end of this tutorial, you’ll have a functional chatbot capable of answering questions based on a custom knowledge base.

Note: Since we may use proprietary models in our tutorials, make sure you have the required API key beforehand.

Step 1: Install and Set Up Haystack

import os
import requests

from haystack import Pipeline
from haystack.components.converters import MarkdownToDocument

from haystack.components.preprocessors import DocumentSplitter
from haystack.components.writers import DocumentWriter

Step 2: Install and Set Up OpenAI GPT-4o

To use OpenAI models, you need to get an OpenAI API key. The Haystack integration with OpenAI models uses an OPENAI_API_KEY environment variable by default. Otherwise, you can pass an API key at initialization with api_key:

generator = OpenAIGenerator(api_key=Secret.from_token("<your-api-key>"), model="gpt-4o-mini")

Then, the generator component needs a prompt to operate, but you can pass any text generation parameters valid for the openai.ChatCompletion.create method directly to this component using the generation_kwargs parameter, both at initialization and to run() method. For more details on the parameters supported by the OpenAI API, refer to the OpenAI documentation.

Now let's install and set up OpenAI models.

from haystack.components.generators import OpenAIGenerator

generator = OpenAIGenerator(model="gpt-4o", api_key=Secret.from_token("<your-api-key>"))

Step 3: Install and Set Up OpenAI text-embedding-3-small

Text documents often come with a set of metadata. If they are distinctive and semantically meaningful, you can embed them along with the text of the document to improve retrieval.

from haystack import Document
from haystack.components.embedders import OpenAIDocumentEmbedder

doc = Document(content="some text",meta={"title": "relevant title", "page number": 18})

document_embedder = OpenAIDocumentEmbedder(meta_fields_to_embed=["title"])

docs_w_embeddings = embedder.run(documents=[doc])["documents"]

Now let's install and set up the model.

from haystack import Document
from haystack.components.embedders import OpenAIDocumentEmbedder
from haystack.components.embedders import OpenAITextEmbedder

text_embedder = OpenAITextEmbedder(api_key=Secret.from_token("<your-api-key>"), model="text-embedding-3-small")
document_embedder = OpenAIDocumentEmbedder(api_key=Secret.from_token("<your-api-key>"), model="text-embedding-3-small")

Step 4: Install and Set Up OpenSearch

If you have Docker set up, we recommend pulling the Docker image and running it.

docker pull opensearchproject/opensearch:2.11.0
docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" -e "ES_JAVA_OPTS=-Xms1024m -Xmx1024m" opensearchproject/opensearch:2.11.0

Once you have a running OpenSearch instance, install the opensearch-haystack integration:

pip install opensearch-haystack

from haystack_integrations.components.retrievers.opensearch  import OpenSearchEmbeddingRetriever
from haystack_integrations.document_stores.opensearch import OpenSearchDocumentStore

document_store = OpenSearchDocumentStore(hosts="http://localhost:9200", use_ssl=True,
verify_certs=False, http_auth=("admin", "admin"))
retriever = OpenSearchEmbeddingRetriever(document_store=document_store)

Step 5: Build a RAG Chatbot

Now that you’ve set up all components, let’s start to build a simple chatbot. We’ll use the Milvus introduction doc as a private knowledge base. You can replace it your own dataset to customize your RAG chatbot.

url = 'https://raw.githubusercontent.com/milvus-io/milvus-docs/refs/heads/v2.5.x/site/en/about/overview.md'
example_file = 'example_file.md'
response = requests.get(url)
with open(example_file, 'wb') as f:
    f.write(response.content)
file_paths = [example_file]  # You can replace it with your own file paths.

indexing_pipeline = Pipeline()
indexing_pipeline.add_component("converter", MarkdownToDocument())
indexing_pipeline.add_component("splitter", DocumentSplitter(split_by="sentence", split_length=2))
indexing_pipeline.add_component("embedder", document_embedder)
indexing_pipeline.add_component("writer", DocumentWriter(document_store))
indexing_pipeline.connect("converter", "splitter")
indexing_pipeline.connect("splitter", "embedder")
indexing_pipeline.connect("embedder", "writer")
indexing_pipeline.run({"converter": {"sources": file_paths}})

# print("Number of documents:", document_store.count_documents())
  
question = "What is Milvus?"  # You can replace it with your own question.

retrieval_pipeline = Pipeline()
retrieval_pipeline.add_component("embedder", text_embedder)
retrieval_pipeline.add_component("retriever", retriever)
retrieval_pipeline.connect("embedder", "retriever")

retrieval_results = retrieval_pipeline.run({"embedder": {"text": question}})

# for doc in retrieval_results["retriever"]["documents"]:
#     print(doc.content)
#     print("-" * 10)

from haystack.utils import Secret
from haystack.components.builders import PromptBuilder

retriever = OpenSearchEmbeddingRetriever(document_store=document_store) 
 text_embedder = OpenAITextEmbedder(api_key=Secret.from_token("<your-api-key>"), model="text-embedding-3-small")

prompt_template = """Answer the following query based on the provided context. If the context does
                     not include an answer, reply with 'I don't know'.\n
                     Query: {{query}}
                     Documents:
                     {% for doc in documents %}
                        {{ doc.content }}
                     {% endfor %}
                     Answer: 
                  """

rag_pipeline = Pipeline()
rag_pipeline.add_component("text_embedder", text_embedder)
rag_pipeline.add_component("retriever", retriever)
rag_pipeline.add_component("prompt_builder", PromptBuilder(template=prompt_template))
rag_pipeline.add_component("generator", generator)
rag_pipeline.connect("text_embedder.embedding", "retriever.query_embedding")
rag_pipeline.connect("retriever.documents", "prompt_builder.documents")
rag_pipeline.connect("prompt_builder", "generator")

results = rag_pipeline.run({"text_embedder": {"text": question}, "prompt_builder": {"query": question},})
print('RAG answer:\n', results["generator"]["replies"][0])

Optimization Tips

As you build your RAG system, optimization is key to ensuring peak performance and efficiency. While setting up the components is an essential first step, fine-tuning each one will help you create a solution that works even better and scales seamlessly. In this section, we’ll share some practical tips for optimizing all these components, giving you the edge to build smarter, faster, and more responsive RAG applications.

Haystack optimization tips

To optimize Haystack in a RAG setup, ensure you use an efficient retriever like FAISS or Milvus for scalable and fast similarity searches. Fine-tune your document store settings, such as indexing strategies and storage backends, to balance speed and accuracy. Use batch processing for embedding generation to reduce latency and optimize API calls. Leverage Haystack's pipeline caching to avoid redundant computations, especially for frequently queried documents. Tune your reader model by selecting a lightweight yet accurate transformer-based model like DistilBERT to speed up response times. Implement query rewriting or filtering techniques to enhance retrieval quality, ensuring the most relevant documents are retrieved for generation. Finally, monitor system performance with Haystack’s built-in evaluation tools to iteratively refine your setup based on real-world query performance.

OpenSearch optimization tips

To optimize OpenSearch in a Retrieval-Augmented Generation (RAG) setup, fine-tune indexing by enabling efficient mappings and reducing unnecessary stored fields. Use HNSW for vector search to speed up similarity queries while balancing recall and latency with appropriate ef_search and ef_construction values. Leverage shard and replica settings to distribute load effectively, and enable caching for frequent queries. Optimize text-based retrieval with BM25 tuning and custom analyzers for better relevance. Regularly monitor cluster health, index size, and query performance using OpenSearch Dashboards and adjust configurations accordingly.

OpenAI GPT-4o optimization tips

To optimize OpenAI GPT-4o in a RAG setup, structure inputs with concise, context-rich prompts and preprocess retrieved documents to remove noise. Use metadata filtering to prioritize relevant sources and limit context length to avoid token waste. Fine-tune retrieval models to align with GPT-4o’s strengths, employ chunking with overlap for continuity, and experiment with temperature and max_token settings for balanced creativity and focus. Cache frequent queries and implement rate limiting to manage costs. Regularly evaluate outputs to refine retrieval and generation alignment.

OpenAI text-embedding-3-small optimization tips

Optimize input text by truncating or chunking to stay within the 8191-token limit while preserving semantic context. Normalize embeddings to unit vectors to improve cosine similarity accuracy. Batch embedding requests to reduce API calls and latency. Experiment with dimensionality reduction (e.g., 256-dim) to balance performance and storage costs. Preprocess text by removing redundant or noisy content and standardizing formats (lowercase, trimming whitespace). Cache frequent or static embeddings to avoid redundant computations. Monitor retrieval quality via metrics like recall@k and adjust chunking strategies or hybrid retrieval methods if needed. Fine-tune temperature and top-k parameters during generation to align with embedding outputs.

By implementing these tips across your components, you'll be able to enhance the performance and functionality of your RAG system, ensuring it’s optimized for both speed and accuracy. Keep testing, iterating, and refining your setup to stay ahead in the ever-evolving world of AI development.

RAG Cost Calculator: A Free Tool to Calculate Your Cost in Seconds

Estimating the cost of a Retrieval-Augmented Generation (RAG) pipeline involves analyzing expenses across vector storage, compute resources, and API usage. Key cost drivers include vector database queries, embedding generation, and LLM inference.

RAG Cost Calculator is a free tool that quickly estimates the cost of building a RAG pipeline, including chunking, embedding, vector storage/search, and LLM generation. It also helps you identify cost-saving opportunities and achieve up to 10x cost reduction on vector databases with the serverless option.

Calculate your RAG cost now.

Calculate your RAG cost

What Have You Learned?

Wow, you’ve just unlocked the magic of building a RAG system from the ground up! By diving into this tutorial, you’ve discovered how to seamlessly weave together four powerhouse components: Haystack as your orchestration framework, OpenSearch as your lightning-fast vector database, OpenAI’s GPT-4o as your creative LLM, and the nimble text-embedding-3-small model to transform text into rich embeddings. You’ve seen how Haystack acts as the glue, connecting retrieval and generation steps into a smooth pipeline. OpenSearch steps up to store and search vectors at scale, ensuring your system finds the most relevant context in milliseconds. Meanwhile, the embedding model breathes life into raw text, capturing nuances so GPT-4o can craft answers that feel both accurate and human. Along the way, you’ve picked up pro tips—like chunking strategies and hybrid search optimizations—to squeeze every drop of performance from your setup, plus a free RAG cost calculator to keep your experiments budget-friendly and efficient.

But wait, there’s more! This isn’t just about following steps—it’s about empowering you to innovate. Imagine tweaking retrieval thresholds, experimenting with custom prompts, or scaling this pipeline to tackle niche domains. The tools are in your hands, and the possibilities are endless. Ready to take the next leap? Start building! Tinker with the code, optimize for speed or accuracy, and let your creativity run wild. Whether you’re crafting a chatbot, a research assistant, or something entirely new, you’ve got the skills to make it happen. The future of intelligent apps is yours to shape—so go out there, iterate fearlessly, and turn those “what ifs” into “heck yeahs!” 🚀

Further Resources

🌟 In addition to this RAG tutorial, unleash your full potential with these incredible resources to level up your RAG skills.

How to Build a Multimodal RAG | Documentation
How to Enhance the Performance of Your RAG Pipeline
Graph RAG with Milvus | Documentation
How to Evaluate RAG Applications - Zilliz Learn
Generative AI Resource Hub | Zilliz

We'd Love to Hear What You Think!

We’d love to hear your thoughts! 🌟 Leave your questions or comments below or join our vibrant Milvus Discord community to share your experiences, ask questions, or connect with thousands of AI enthusiasts. Your journey matters to us!

If you like this tutorial, show your support by giving our Milvus GitHub repo a star ⭐—it means the world to us and inspires us to keep creating! 💖