docs/source/en/examples/rag.mdx

<!--Copyright 2024 The HuggingFace Team. All rights reserved.



Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0



Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on

an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the

specific language governing permissions and limitations under the License.



⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be

rendered properly in your Markdown viewer.



-->

# Agentic RAG



[[open-in-colab]]



Retrieval-Augmented-Generation (RAG) is “using an LLM to answer a user query, but basing the answer on information retrieved from a knowledge base”. It has many advantages over using a vanilla or fine-tuned LLM: to name a few, it allows to ground the answer on true facts and reduce confabulations, it allows to provide the LLM with domain-specific knowledge, and it allows fine-grained control of access to information from the knowledge base.



But vanilla RAG has limitations, most importantly these two:

- It performs only one retrieval step: if the results are bad, the generation in turn will be bad.

- Semantic similarity is computed with the user query as a reference, which might be suboptimal: for instance, the user query will often be a question and the document containing the true answer will be in affirmative voice, so its similarity score will be downgraded compared to other source documents in the interrogative form, leading to a risk of missing the relevant information.



We can alleviate these problems by making a RAG agent: very simply, an agent armed with a retriever tool!



This agent will: ✅ Formulate the query itself and ✅ Critique to re-retrieve if needed.



So it should naively recover some advanced RAG techniques!

- Instead of directly using the user query as the reference in semantic search, the agent formulates itself a reference sentence that can be closer to the targeted documents, as in [HyDE](https://huggingface.co/papers/2212.10496).

The agent can use the generated snippets and re-retrieve if needed, as in [Self-Query](https://docs.llamaindex.ai/en/stable/examples/evaluation/RetryQuery/).



Let's build this system. 🛠️



Run the line below to install required dependencies:

```bash

!pip install smolagents pandas langchain langchain-community sentence-transformers datasets python-dotenv rank_bm25 --upgrade -q

```

To call the HF Inference API, you will need a valid token as your environment variable `HF_TOKEN`.

We use python-dotenv to load it.

```py

from dotenv import load_dotenv

load_dotenv()

```



We first load a knowledge base on which we want to perform RAG: this dataset is a compilation of the documentation pages for many Hugging Face libraries, stored as markdown. We will keep only the documentation for the `transformers` library.



Then prepare the knowledge base by processing the dataset and storing it into a vector database to be used by the retriever.



We use [LangChain](https://python.langchain.com/docs/introduction/) for its excellent vector database utilities.



```py

import datasets

from langchain.docstore.document import Document

from langchain.text_splitter import RecursiveCharacterTextSplitter

from langchain_community.retrievers import BM25Retriever



knowledge_base = datasets.load_dataset("m-ric/huggingface_doc", split="train")

knowledge_base = knowledge_base.filter(lambda row: row["source"].startswith("huggingface/transformers"))



source_docs = [

    Document(page_content=doc["text"], metadata={"source": doc["source"].split("/")[1]})

    for doc in knowledge_base

]



text_splitter = RecursiveCharacterTextSplitter(

    chunk_size=500,

    chunk_overlap=50,

    add_start_index=True,

    strip_whitespace=True,

    separators=["\n\n", "\n", ".", " ", ""],

)

docs_processed = text_splitter.split_documents(source_docs)

```



Now the documents are ready.



So let’s build our agentic RAG system!



👉 We only need a RetrieverTool that our agent can leverage to retrieve information from the knowledge base.



Since we need to add a vectordb as an attribute of the tool, we cannot simply use the simple tool constructor with a `@tool` decorator: so we will follow the advanced setup highlighted in the [tools tutorial](../tutorials/tools).



```py

from smolagents import Tool



class RetrieverTool(Tool):

    name = "retriever"

    description = "Uses semantic search to retrieve the parts of transformers documentation that could be most relevant to answer your query."

    inputs = {

        "query": {

            "type": "string",

            "description": "The query to perform. This should be semantically close to your target documents. Use the affirmative form rather than a question.",

        }

    }

    output_type = "string"



    def __init__(self, docs, **kwargs):

        super().__init__(**kwargs)

        self.retriever = BM25Retriever.from_documents(

            docs, k=10

        )



    def forward(self, query: str) -> str:

        assert isinstance(query, str), "Your search query must be a string"



        docs = self.retriever.invoke(

            query,

        )

        return "\nRetrieved documents:\n" + "".join(

            [

                f"\n\n===== Document {str(i)} =====\n" + doc.page_content

                for i, doc in enumerate(docs)

            ]

        )



retriever_tool = RetrieverTool(docs_processed)

```

We have used BM25, a classic retrieval method, because it's lightning fast to setup.

To improve retrieval accuracy, you could use replace BM25 with semantic search using vector representations for documents: thus you can head to the [MTEB Leaderboard](https://huggingface.co/spaces/mteb/leaderboard) to select a good embedding model.



Now it’s straightforward to create an agent that leverages this `retriever_tool`!



The agent will need these arguments upon initialization:

- `tools`: a list of tools that the agent will be able to call.

- `model`: the LLM that powers the agent.

Our `model` must be a callable that takes as input a list of messages and returns text. It also needs to accept a stop_sequences argument that indicates when to stop its generation. For convenience, we directly use the HfEngine class provided in the package to get a LLM engine that calls Hugging Face's Inference API.



>[!NOTE] To use a specific model, pass it like this: `HfApiModel("meta-llama/Llama-3.3-70B-Instruct")`. The Inference API hosts models based on various criteria, and deployed models may be updated or replaced without prior notice. Learn more about it [here](https://huggingface.co/docs/api-inference/supported-models).



```py

from smolagents import HfApiModel, CodeAgent



agent = CodeAgent(

    tools=[retriever_tool], model=HfApiModel(), max_steps=4, verbosity_level=2

)

```

Upon initializing the CodeAgent, it has been automatically given a default system prompt that tells the LLM engine to process step-by-step and generate tool calls as code snippets, but you could replace this prompt template with your own as needed.



Then when its `.run()` method is launched, the agent takes care of calling the LLM engine, and executing the tool calls, all in a loop that ends only when tool `final_answer` is called with the final answer as its argument.



```py

agent_output = agent.run("For a transformers model training, which is slower, the forward or the backward pass?")



print("Final output:")

print(agent_output)

```