#
Agentic RAG: turbocharge your RAG with query reformulation and self-query! 🚀

Authored by: Aymeric Roucher

> This tutorial is advanced. You should have notions from this other cookbook first!

> Reminder: 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.

But 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
- The agent can the generated snippets and re-retrieve if needed, as in Self-Query

Let’s build this system. 🛠️

Run the line below to install required dependencies:

    !pip install pandas langchain langchain-community sentence-transformers faiss-cpu "transformers[agents]"

We first load a knowledge base on which we want to perform RAG: this dataset is a compilation of the documentation pages for many `huggingface` packages, stored as markdown.

    import datasets

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

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

We use LangChain for its excellent vector database utilities. For the embedding model, we use thenlper/gte-small since it performed well in our `RAG_evaluation` cookbook.

    >>> from transformers import AutoTokenizer
    >>> from langchain.docstore.document import Document
    >>> from langchain.text_splitter import RecursiveCharacterTextSplitter
    >>> from langchain.vectorstores import FAISS
    >>> from langchain_community.embeddings import HuggingFaceEmbeddings
    >>> from langchain_community.vectorstores.utils import DistanceStrategy
    >>> from tqdm import tqdm

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

    >>> text_splitter = RecursiveCharacterTextSplitter.from_huggingface_tokenizer(
    ...     AutoTokenizer.from_pretrained("thenlper/gte-small"),
    ...     chunk_size=200,
    ...     chunk_overlap=20,
    ...     add_start_index=True,
    ...     strip_whitespace=True,
    ...     separators=["\n\n", "\n", ".", " ", ""],
    ... )

    >>> # Split docs and keep only unique ones
    >>> print("Splitting documents...")
    >>> docs_processed = []
    >>> unique_texts = {}
    >>> for doc in tqdm(source_docs):
    ...     new_docs = text_splitter.split_documents([doc])
    ...     for new_doc in new_docs:
    ...         if new_doc.page_content not in unique_texts:
    ...             unique_texts[doc.page_content] = True
    ...             docs_processed.append(new_doc)

    >>> print("Embedding documents... This should take a few minutes (5 minutes on MacBook with M1 Pro)")
    >>> embedding_model = HuggingFaceEmbeddings(model_name="thenlper/gte-small")
    >>> vectordb = FAISS.from_documents(
    ...     documents=docs_processed,
    ...     embedding=embedding_model,
    ...     distance_strategy=DistanceStrategy.COSINE,
    ... )

    Splitting documents...

Now the database is ready: let’s build our agentic RAG system!

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

    from transformers.agents import Tool
    from langchain_core.vectorstores import VectorStore

    class RetrieverTool(Tool):
        name = "retriever"
        description = "Using semantic similarity, retrieves some documents from the knowledge base that have the closest embeddings to the input query."
        inputs = {
            "query": {
                "type": "text",
                "description": "The query to perform. This should be semantically close to your target documents. Use the affirmative form rather than a question.",
            }
        }
        output_type = "text"

        def __init__(self, vectordb: VectorStore, **kwargs):
            super().__init__(**kwargs)
            self.vectordb = vectordb

        def forward(self, query: str) -> str:
            assert isinstance(query, str), "Your search query must be a string"

            docs = self.vectordb.similarity_search(
                query,
                k=7,
            )

            return "\nRetrieved documents:\n" + "".join(
                [f"===== Document {str(i)} =====\n" + doc.page_content for i, doc in enumerate(docs)]
            )

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

The agent will need these arguments upon initialization:

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

Our `llm_engine` 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 our Inference API.

And we use CohereForAI/c4ai-command-r-plus as the llm engine because:

- It has a long 128k context, which is helpful for processing long source documents
- It is served for free at all times on HF’s Inference API!

    from transformers.agents import HfEngine, ReactJsonAgent

    llm_engine = HfEngine("CohereForAI/c4ai-command-r-plus")

    retriever_tool = RetrieverTool(vectordb)
    agent = ReactJsonAgent(tools=[retriever_tool], llm_engine=llm_engine, max_iterations=4, verbose=2)

Since we initialized the agent as a `ReactJsonAgent`, it has been automatically given a default system prompt that tells the LLM engine to process step-by-step and generate tool calls as JSON blobs (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, parsing the tool call JSON blobs and executing these tool calls, all in a loop that ends only when the final answer is provided.

    >>> agent_output = agent.run("How can I push a model to the Hub?")

    >>> print("Final output:")
    >>> print(agent_output)

    Final output:
    There are multiple ways to push a model to the Hub. Here are a few examples using different libraries and functions:

    Using the `api`:
    python
    api.upload_folder(
        repo_id=repo_id,
        folder_path=repo_local_path,
        path_in_repo='.',
    )

    print('Your model is pushed to the Hub. You can view your model here:', repo_url)

    With Transformers:
    python
    from transformers import PushToHubCallback

    # Initialize the callback with the output directory,
    tokenizer, and your Hub username and model name
    push_to_hub_callback = PushToHubCallback(
        output_dir='./your_model_save_path',
        tokenizer=tokenizer,
        hub_model_id='your-username/my-awesome-model'
    )

    # Assuming `trainer` is your Trainer object
    trainer.add_callback(push_to_hub_callback)

    Using `timm`:
    python
    from timm.models.hub import push_to_hf_hub

    # Assuming `model` is your fine-tuned model
    model_cfg = &#123;'labels': ['a', 'b', 'c', 'd']}
    push_to_hf_hub(model, 'resnet18-random', model_config=model_cfg)

    For computer vision models, you can also use `push_to_hub`:
    python
    processor.push_to_hub(hub_model_id)
    trainer.push_to_hub(**kwargs)

    You can also manually push a model with `model.push_to_hub()`:
    python
    model.push_to_hub()

    Additionally, you can opt to push your model to the Hub at the end of training by specifying `push_to_hub=True` in the training configuration. Don't forget to have git-lfs installed and be logged into your Hugging Face account.

##
Agentic RAG vs. standard RAG

Does the agent setup make a better RAG system? Well, let’s comapre it to a standard RAG system using LLM Judge!

We will use meta-llama/Meta-Llama-3-70B-Instruct for evaluation since it’s one of the strongest OS models we tested for LLM judge use cases.

    eval_dataset = datasets.load_dataset("m-ric/huggingface_doc_qa_eval", split="train")

Before running the test let’s make the agent less verbose.

    import logging

    agent.logger.setLevel(logging.WARNING)

    outputs_agentic_rag = []

    for example in tqdm(eval_dataset):
        question = example["question"]

        enhanced_question = f"""Using the information contained in your knowledge base, which you can access with the 'retriever' tool,
    give a comprehensive answer to the question below.
    Respond only to the question asked, response should be concise and relevant to the question.
    If you cannot find information, do not give up and try calling your retriever again with different arguments!
    Make sure to have covered the question completely by calling the retriever tool several times with semantically different queries.
    Your queries should not be questions but affirmative form sentences: e.g. rather than "How do I load a model from the Hub in bf16?", query should be "load a model from the Hub bf16 weights".

    Question:
    {question}"""
        answer = agent.run(enhanced_question)
        print("=======================================================")
        print(f"Question: {question}")
        print(f"Answer: {answer}")
        print(f'True answer: {example["answer"]}')

        results_agentic = {
            "question": question,
            "true_answer": example["answer"],
            "source_doc": example["source_doc"],
            "generated_answer": answer,
        }
        outputs_agentic_rag.append(results_agentic)

    from huggingface_hub import InferenceClient

    reader_llm = InferenceClient("CohereForAI/c4ai-command-r-plus")

    outputs_standard_rag = []

    for example in tqdm(eval_dataset):
        question = example["question"]
        context = retriever_tool(question)

        prompt = f"""Given the question and supporting documents below, give a comprehensive answer to the question.
    Respond only to the question asked, response should be concise and relevant to the question.
    Provide the number of the source document when relevant.
    If you cannot find information, do not give up and try calling your retriever again with different arguments!

    Question:
    {question}

    {context}
    """
        messages = [{"role": "user", "content": prompt}]
        answer = reader_llm.chat_completion(messages).choices[0].message.content

        print("=======================================================")
        print(f"Question: {question}")
        print(f"Answer: {answer}")
        print(f'True answer: {example["answer"]}')

        results_agentic = {
            "question": question,
            "true_answer": example["answer"],
            "source_doc": example["source_doc"],
            "generated_answer": answer,
        }
        outputs_standard_rag.append(results_agentic)

The evaluation prompt follows some of the best principles shown in our llm_judge cookbook: it follows a small integer Likert scale, has clear criteria, and a description for each score.

    EVALUATION_PROMPT = """You are a fair evaluator language model.

    You will be given an instruction, a response to evaluate, a reference answer that gets a score of 3, and a score rubric representing a evaluation criteria are given.
    1. Write a detailed feedback that assess the quality of the response strictly based on the given score rubric, not evaluating in general.
    2. After writing a feedback, write a score that is an integer between 1 and 3. You should refer to the score rubric.
    3. The output format should look as follows: \"Feedback: {{write a feedback for criteria}} [RESULT] {{an integer number between 1 and 3}}\"
    4. Please do not generate any other opening, closing, and explanations. Be sure to include [RESULT] in your output.
    5. Do not score conciseness: a correct answer that covers the question should receive max score, even if it contains additional useless information.

    The instruction to evaluate:
    {instruction}

    Response to evaluate:
    {response}

    Reference Answer (Score 3):
    {reference_answer}

    Score Rubrics:
    [Is the response complete, accurate, and factual based on the reference answer?]
    Score 1: The response is completely incomplete, inaccurate, and/or not factual.
    Score 2: The response is somewhat complete, accurate, and/or factual.
    Score 3: The response is completely complete, accurate, and/or factual.

    Feedback:"""

    from huggingface_hub import InferenceClient

    evaluation_client = InferenceClient("meta-llama/Meta-Llama-3-70B-Instruct")

    >>> import pandas as pd

    >>> for type, outputs in [
    ...     ("agentic", outputs_agentic_rag),
    ...     ("standard", outputs_standard_rag),
    ... ]:
    ...     for experiment in tqdm(outputs):
    ...         eval_prompt = EVALUATION_PROMPT.format(
    ...             instruction=experiment["question"],
    ...             response=experiment["generated_answer"],
    ...             reference_answer=experiment["true_answer"],
    ...         )
    ...         messages = [
    ...             {"role": "system", "content": "You are a fair evaluator language model."},
    ...             {"role": "user", "content": eval_prompt},
    ...         ]

    ...         eval_result = evaluation_client.text_generation(eval_prompt, max_new_tokens=1000)
    ...         try:
    ...             feedback, score = [item.strip() for item in eval_result.split("[RESULT]")]
    ...             experiment["eval_score_LLM_judge"] = score
    ...             experiment["eval_feedback_LLM_judge"] = feedback
    ...         except:
    ...             print(f"Parsing failed - output was: {eval_result}")

    ...     results = pd.DataFrame.from_dict(outputs)
    ...     results = results.loc[~results["generated_answer"].str.contains("Error")]
    ...     results["eval_score_LLM_judge_int"] = results["eval_score_LLM_judge"].fillna(1).apply(lambda x: int(x))
    ...     results["eval_score_LLM_judge_int"] = (results["eval_score_LLM_judge_int"] - 1) / 2

    ...     print(f"Average score for {type} RAG: {results['eval_score_LLM_judge_int'].mean()*100:.1f}%")

    Average score for agentic RAG: 78.5%

Let us recap: the Agent setup improves scores by 8.5% compared to a standard RAG! (from 70.0% to 78.5%)

This is a great improvement, with a very simple setup 🚀

(For a baseline, using Llama-3-70B without the knowledge base got 36%)

< > Update on GitHub