copied files

Dockerfile

@@ -0,0 +1,11 @@
+FROM python:3.9
+RUN useradd -m -u 1000 user
+USER user
+ENV HOME=/home/user \
+    PATH=/home/user/.local/bin:$PATH
+WORKDIR $HOME/app
+COPY --chown=user . $HOME/app
+COPY ./requirements.txt ~/app/requirements.txt
+RUN pip install -r requirements.txt
+COPY . .
+CMD ["chainlit", "run", "app.py", "--port", "7860"]

Open_Source_RAG_Leveraging_Hugging_Face_Endpoints_through_LangChain.ipynb

@@ -0,0 +1,640 @@
+{
+  "cells": [
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "lcW6UWldWUMp"
+      },
+      "source": [
+        "# Open Source RAG - Leveraging Hugging Face Endpoints through LangChain\n",
+        "\n",
+        "In the following notebook we will dive into the world of Open Source models hosted on Hugging Face's [inference endpoints](https://ui.endpoints.huggingface.co/).\n",
+        "\n",
+        "The notebook will be broken into the following parts:\n",
+        "\n",
+        "- 🤝 Breakout Room #2:\n",
+        "  1. Install required libraries\n",
+        "  2. Set Environment Variables\n",
+        "  3. Creating LangChain components powered by the endpoints\n",
+        "  4. Creating a simple RAG pipeline with [LangChain v0.2.0](https://blog.langchain.dev/langchain-v02-leap-to-stability/)"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "-spIWt2J3Quk"
+      },
+      "source": [
+        "## Task 1: Install required libraries\n",
+        "\n",
+        "Now we've got to get our required libraries!\n",
+        "\n",
+        "We'll start with our `langchain` and `huggingface` dependencies.\n",
+        "\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 1,
+      "metadata": {
+        "id": "EwGLnp31jXJj"
+      },
+      "outputs": [
+        {
+          "name": "stdout",
+          "output_type": "stream",
+          "text": [
+            "\u001b[31mERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.\n",
+            "s3fs 2023.3.0 requires fsspec==2023.3.0, but you have fsspec 2024.6.0 which is incompatible.\u001b[0m\u001b[31m\n",
+            "\u001b[0m"
+          ]
+        }
+      ],
+      "source": [
+        "!pip install -qU langchain-huggingface langchain-community faiss-cpu"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "SpZTBLwK3TIz"
+      },
+      "source": [
+        "## Task 2: Set Environment Variables\n",
+        "\n",
+        "We'll need to set our `HF_TOKEN` so that we can send requests to our protected API endpoint.\n",
+        "\n",
+        "We'll also set-up our OpenAI API key, which we'll leverage later.\n",
+        "\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 2,
+      "metadata": {
+        "colab": {
+          "base_uri": "https://localhost:8080/"
+        },
+        "id": "NspG8I0XlFTt",
+        "outputId": "edbf992c-97c0-46b1-9b69-40651a5e60d1"
+      },
+      "outputs": [],
+      "source": [
+        "import os\n",
+        "import getpass\n",
+        "\n",
+        "os.environ[\"HF_TOKEN\"] = getpass.getpass(\"HuggingFace Write Token: \")"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "QMru14VBZAtw"
+      },
+      "source": [
+        "## Task 3: Creating LangChain components powered by the endpoints\n",
+        "\n",
+        "We're going to wrap our endpoints in LangChain components in order to leverage them, thanks to LCEL, as we would any other LCEL component!"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "TGooehdzcmPb"
+      },
+      "source": [
+        "### HuggingFaceEndpoint for LLM\n",
+        "\n",
+        "We can use the `HuggingFaceEndpoint` found [here](https://github.com/langchain-ai/langchain/blob/master/libs/community/langchain_community/llms/huggingface_endpoint.py) to power our chain - let's look at how we would implement it."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 98,
+      "metadata": {
+        "id": "N7u2Tu1FsURh"
+      },
+      "outputs": [],
+      "source": [
+        "YOUR_LLM_ENDPOINT_URL = \"YOUR LLM_ENDPOINT_URL HERE\""
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 99,
+      "metadata": {
+        "colab": {
+          "base_uri": "https://localhost:8080/"
+        },
+        "id": "L3Cz6Mrnt2ku",
+        "outputId": "f23f611f-5f08-4332-a74c-5b8d8311d185"
+      },
+      "outputs": [
+        {
+          "name": "stdout",
+          "output_type": "stream",
+          "text": [
+            "The token has not been saved to the git credentials helper. Pass `add_to_git_credential=True` in this function directly or `--add-to-git-credential` if using via `huggingface-cli` if you want to set the git credential as well.\n",
+            "Token is valid (permission: write).\n",
+            "Your token has been saved to /root/.cache/huggingface/token\n",
+            "Login successful\n"
+          ]
+        }
+      ],
+      "source": [
+        "from langchain_community.llms import HuggingFaceEndpoint\n",
+        "\n",
+        "hf_llm = HuggingFaceEndpoint(\n",
+        "    endpoint_url=f\"{YOUR_LLM_ENDPOINT_URL}\",\n",
+        "    max_new_tokens=512,\n",
+        "    top_k=10,\n",
+        "    top_p=0.95,\n",
+        "    typical_p=0.95,\n",
+        "    temperature=0.01,\n",
+        "    repetition_penalty=1.03,\n",
+        "    huggingfacehub_api_token=os.environ[\"HF_TOKEN\"]\n",
+        ")"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "fun4XrRxZK9n"
+      },
+      "source": [
+        "Now we can use our endpoint like we would any other LLM!"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 104,
+      "metadata": {
+        "colab": {
+          "base_uri": "https://localhost:8080/",
+          "height": 127
+        },
+        "id": "OFAbFT91Z8QV",
+        "outputId": "588714ad-da28-4330-801b-7121b6f17ccf"
+      },
+      "outputs": [
+        {
+          "data": {
+            "application/vnd.google.colaboratory.intrinsic+json": {
+              "type": "string"
+            },
+            "text/plain": [
+              "\" I hope you're having a great day! I just wanted to say that I'm really enjoying your blog and the information you share. It's always great to learn something new and I appreciate the effort you put into creating such a valuable resource. Keep up the good work! Best regards, [Your Name]\\nI hope this message is helpful. Let me know if you have any questions or need further assistance. Thank you for your time and consideration. Best regards, [Your Name]\\nI hope this message is helpful. Let me know if you have any questions or need further assistance. Thank you for your time and consideration. Best regards, [Your Name]\\nI hope this message is helpful. Let me know if you have any questions or need further assistance. Thank you for your time and consideration. Best regards, [Your Name]\\nI hope this message is helpful. Let me know if you have any questions or need further assistance. Thank you for your time and consideration. Best regards, [Your Name]\\nI hope this message is helpful. Let me know if you have any questions or need further assistance. Thank you for your time and consideration. Best regards, [Your Name]\\nI hope this message is helpful. Let me know if you have any questions or need further assistance. Thank you for your time and consideration. Best regards, [Your Name]\\nI hope this message is helpful. Let me know if you have any questions or need further assistance. Thank you for your time and consideration. Best regards, [Your Name]\\nI hope this message is helpful. Let me know if you have any questions or need further assistance. Thank you for your time and consideration. Best regards, [Your Name]\\nI hope this message is helpful. Let me know if you have any questions or need further assistance. Thank you for your time and consideration. Best regards, [Your Name]\\nI hope this message is helpful. Let me know if you have any questions or need further assistance. Thank you for your time and consideration. Best regards, [Your Name]\\nI hope this message is helpful. Let me know if you have any questions or need further assistance. Thank you for your time and consideration. Best regards, [Your Name]\\nI hope this message is helpful. Let me know if you have any questions or need further assistance. Thank you for your time and consideration. Best regards, [Your Name]\\nI hope this message is helpful. Let me know if you have any questions or need further assistance. Thank you for your time and consideration. Best regards\""
+            ]
+          },
+          "execution_count": 104,
+          "metadata": {},
+          "output_type": "execute_result"
+        }
+      ],
+      "source": [
+        "hf_llm.invoke(\"Hello, how are you?\")"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "ngH3fhw4aQ8T"
+      },
+      "source": [
+        "Now we can add a RAG-style prompt using Llama 3 Instruct's prompt templating!"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 101,
+      "metadata": {
+        "id": "zdvv4JmkzEtj"
+      },
+      "outputs": [],
+      "source": [
+        "from langchain_core.prompts import PromptTemplate\n",
+        "\n",
+        "RAG_PROMPT_TEMPLATE = \"\"\"\\\n",
+        "<|start_header_id|>system<|end_header_id|>\n",
+        "You are a helpful assistant. You answer user questions based on provided context. If you can't answer the question with the provided context, say you don't know.<|eot_id|>\n",
+        "\n",
+        "<|start_header_id|>user<|end_header_id|>\n",
+        "User Query:\n",
+        "{query}\n",
+        "\n",
+        "Context:\n",
+        "{context}<|eot_id|>\n",
+        "\n",
+        "<|start_header_id|>assistant<|end_header_id|>\n",
+        "\"\"\"\n",
+        "\n",
+        "rag_prompt = PromptTemplate.from_template(RAG_PROMPT_TEMPLATE)"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "Oe0Qrzn4adzh"
+      },
+      "source": [
+        "Let's create a simple LCEL chain using our prompt template Runnable and our LLM Runnable."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 102,
+      "metadata": {
+        "id": "CE4djpxM0-Fg"
+      },
+      "outputs": [],
+      "source": [
+        "rag_chain = rag_prompt | hf_llm"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 103,
+      "metadata": {
+        "colab": {
+          "base_uri": "https://localhost:8080/",
+          "height": 36
+        },
+        "id": "PNwrLXqDxHDY",
+        "outputId": "f6803286-1aa5-488a-eea9-8bece68da7f5"
+      },
+      "outputs": [
+        {
+          "data": {
+            "application/vnd.google.colaboratory.intrinsic+json": {
+              "type": "string"
+            },
+            "text/plain": [
+              "'According to the context, Carl is 40 years old.'"
+            ]
+          },
+          "execution_count": 103,
+          "metadata": {},
+          "output_type": "execute_result"
+        }
+      ],
+      "source": [
+        "rag_chain.invoke({\"query\" : \"Who old is Carl?\", \"context\" : \"Carl is a sweet dude, he's 40.\"})"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "emGw4-66aBfa"
+      },
+      "source": [
+        "### HuggingFaceInferenceAPIEmbeddings\n",
+        "\n",
+        "Now we can leverage the `HuggingFaceInferenceAPIEmbeddings` module in LangChain to connect to our Hugging Face Inference Endpoint hosted embedding model."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 105,
+      "metadata": {
+        "id": "n9Q7e4Gnwe_C"
+      },
+      "outputs": [],
+      "source": [
+        "from langchain_huggingface.embeddings import HuggingFaceEndpointEmbeddings\n",
+        "\n",
+        "YOUR_EMBED_MODEL_URL = \"YOUR EMBED MODEL URL HERE\"\n",
+        "\n",
+        "hf_embeddings = HuggingFaceEndpointEmbeddings(\n",
+        "    model=YOUR_EMBED_MODEL_URL,\n",
+        "    task=\"feature-extraction\",\n",
+        "    huggingfacehub_api_token=os.environ[\"HF_TOKEN\"],\n",
+        ")"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "YXYRBqbBayWb"
+      },
+      "source": [
+        "Let's build a simple cosine-similarity function to verify our endpoint is working as expected."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "id": "lOP6LKr74RG8"
+      },
+      "outputs": [],
+      "source": [
+        "import numpy as np\n",
+        "from numpy.linalg import norm\n",
+        "\n",
+        "def cosine_similarity(phrase_1, phrase_2):\n",
+        "  vec_1 = hf_embeddings.embed_documents([phrase_1])[0]\n",
+        "  vec2_2 = hf_embeddings.embed_documents([phrase_2])[0]\n",
+        "  return np.dot(vec_1, vec2_2) / (norm(vec_1) * norm(vec2_2))"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "uGZNhxF2bVIr"
+      },
+      "source": [
+        "Let's try a few examples below!"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "colab": {
+          "base_uri": "https://localhost:8080/"
+        },
+        "id": "5o_cqEZ34f15",
+        "outputId": "d3eb4933-8842-4278-fe48-2dc15e430b60"
+      },
+      "outputs": [
+        {
+          "data": {
+            "text/plain": [
+              "0.8903063446222079"
+            ]
+          },
+          "execution_count": 44,
+          "metadata": {},
+          "output_type": "execute_result"
+        }
+      ],
+      "source": [
+        "cosine_similarity(\"I love my fluffy dog!\", \"I adore this furry puppy!\")"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "colab": {
+          "base_uri": "https://localhost:8080/"
+        },
+        "id": "R1nsAV1n4w4a",
+        "outputId": "db53d783-4c87-404f-de67-fc1d01583e68"
+      },
+      "outputs": [
+        {
+          "data": {
+            "text/plain": [
+              "0.743020791930313"
+            ]
+          },
+          "execution_count": 48,
+          "metadata": {},
+          "output_type": "execute_result"
+        }
+      ],
+      "source": [
+        "cosine_similarity(\"I love my fluffy dog!\", \"Eating pizza is the worst! Yuck!\")"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "iiz6vKMlbbP4"
+      },
+      "source": [
+        "## Task 4: Preparing Data!\n",
+        "\n",
+        "We'll start by loading some data from GitHub (Paul Graham's Essays) and then move to chunking them into manageable pieces!\n",
+        "\n",
+        "First - let's grab the repository where the files live."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "colab": {
+          "base_uri": "https://localhost:8080/"
+        },
+        "id": "AkuzZben5Eqp",
+        "outputId": "eb8d39ae-fd70-4691-ddaa-1f8aa15f1c19"
+      },
+      "outputs": [
+        {
+          "name": "stdout",
+          "output_type": "stream",
+          "text": [
+            "Cloning into 'paul-graham-to-kindle'...\n",
+            "remote: Enumerating objects: 36, done.\u001b[K\n",
+            "remote: Counting objects: 100% (36/36), done.\u001b[K\n",
+            "remote: Compressing objects: 100% (33/33), done.\u001b[K\n",
+            "remote: Total 36 (delta 3), reused 31 (delta 1), pack-reused 0\u001b[K\n",
+            "Receiving objects: 100% (36/36), 2.35 MiB | 7.13 MiB/s, done.\n",
+            "Resolving deltas: 100% (3/3), done.\n"
+          ]
+        }
+      ],
+      "source": [
+        "!git clone https://github.com/dbredvick/paul-graham-to-kindle.git"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "8prMk6R0bsYd"
+      },
+      "source": [
+        "Next - we can load them using LangChain!"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 106,
+      "metadata": {
+        "id": "K155zM7e53lt"
+      },
+      "outputs": [],
+      "source": [
+        "from langchain_community.document_loaders import TextLoader\n",
+        "\n",
+        "document_loader = TextLoader(\"./paul-graham-to-kindle/paul_graham_essays.txt\")\n",
+        "documents = document_loader.load()"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "5wYfo6_0bwVc"
+      },
+      "source": [
+        "Now, let's split them into 1000 character pieces."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 108,
+      "metadata": {
+        "colab": {
+          "base_uri": "https://localhost:8080/"
+        },
+        "id": "w-Gx_0iL6Ikc",
+        "outputId": "4cd1de4f-8a7d-4727-dc92-0ce3d321a82f"
+      },
+      "outputs": [
+        {
+          "data": {
+            "text/plain": [
+              "4265"
+            ]
+          },
+          "execution_count": 108,
+          "metadata": {},
+          "output_type": "execute_result"
+        }
+      ],
+      "source": [
+        "from langchain_text_splitters import RecursiveCharacterTextSplitter\n",
+        "\n",
+        "text_splitter = RecursiveCharacterTextSplitter(chunk_size=1000, chunk_overlap=30)\n",
+        "split_documents = text_splitter.split_documents(documents)\n",
+        "len(split_documents)"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "d5HrkDhTb4i_"
+      },
+      "source": [
+        "Just the same as we would with OpenAI's embeddings model - we can instantiate our `FAISS` vector store with our documents and our `HuggingFaceEmbeddings` model!\n",
+        "\n",
+        "We'll need to take a few extra steps, though, due to a few limitations of the endpoint/FAISS.\n",
+        "\n",
+        "We'll start by embeddings our documents in batches of `32`.\n",
+        "\n",
+        "> NOTE: This process might take a while depending on the compute you assigned your embedding endpoint!"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 110,
+      "metadata": {
+        "id": "ucghQgRp6YXr"
+      },
+      "outputs": [],
+      "source": [
+        "from langchain_community.vectorstores import FAISS\n",
+        "\n",
+        "for i in range(0, len(split_documents), 32):\n",
+        "  if i == 0:\n",
+        "    vectorstore = FAISS.from_documents(split_documents[i:i+32], hf_embeddings)\n",
+        "    continue\n",
+        "  vectorstore.add_documents(split_documents[i:i+32])"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "q07ZUp6Db_AO"
+      },
+      "source": [
+        "Next, we set up FAISS as a retriever."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 111,
+      "metadata": {
+        "id": "fXr-yrAq7h8V"
+      },
+      "outputs": [],
+      "source": [
+        "hf_retriever = vectorstore.as_retriever()"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "sYrW6FRecO7U"
+      },
+      "source": [
+        "## Task 5: Simple LCEL RAG Chain\n",
+        "\n",
+        "Now we can set up our LCEL RAG chain!\n",
+        "\n",
+        "> NOTE: We're not returning context for this example, and only returning the text output from the LLM."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 112,
+      "metadata": {
+        "id": "ffIzIlct8ISb"
+      },
+      "outputs": [],
+      "source": [
+        "from operator import itemgetter\n",
+        "from langchain.schema.output_parser import StrOutputParser\n",
+        "from langchain.schema.runnable import RunnablePassthrough\n",
+        "\n",
+        "lcel_rag_chain = {\"context\": itemgetter(\"query\") | hf_retriever, \"query\": itemgetter(\"query\")}| rag_prompt | hf_llm"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 114,
+      "metadata": {
+        "colab": {
+          "base_uri": "https://localhost:8080/",
+          "height": 127
+        },
+        "id": "HOQfkEgb8nPH",
+        "outputId": "92601728-d001-43e2-e543-e714d66f4f4e"
+      },
+      "outputs": [
+        {
+          "data": {
+            "application/vnd.google.colaboratory.intrinsic+json": {
+              "type": "string"
+            },
+            "text/plain": [
+              "\"Based on the provided context, it seems that Paul Graham, the author, is discussing the shortcomings of Silicon Valley and suggesting ways to improve it. He mentions that the best part of Silicon Valley is not the physical buildings, but the people who make it Silicon Valley.\\n\\nHowever, he also criticizes the current state of Silicon Valley, saying that it's too far from San Francisco, has poor public transportation, and is plagued by strip development. He suggests that to create a better Silicon Valley, one should focus on designing a town that prioritizes public transportation, walkability, and bikeability, rather than car-centric development.\\n\\nSo, in summary, the best part of Silicon Valley, according to Paul Graham, is the people, but the area itself has many weaknesses that need to be addressed to make it a more desirable place for startups and innovators.\""
+            ]
+          },
+          "execution_count": 114,
+          "metadata": {},
+          "output_type": "execute_result"
+        }
+      ],
+      "source": [
+        "lcel_rag_chain.invoke({\"query\" : \"What is the best part of Silicon Valley?\"})"
+      ]
+    }
+  ],
+  "metadata": {
+    "colab": {
+      "provenance": [],
+      "toc_visible": true
+    },
+    "kernelspec": {
+      "display_name": "Python 3",
+      "name": "python3"
+    },
+    "language_info": {
+      "codemirror_mode": {
+        "name": "ipython",
+        "version": 3
+      },
+      "file_extension": ".py",
+      "mimetype": "text/x-python",
+      "name": "python",
+      "nbconvert_exporter": "python",
+      "pygments_lexer": "ipython3",
+      "version": "3.11.9"
+    }
+  },
+  "nbformat": 4,
+  "nbformat_minor": 0
+}

app.py

@@ -0,0 +1,132 @@
+import os
+import chainlit as cl
+from dotenv import load_dotenv
+from operator import itemgetter
+from langchain_huggingface import HuggingFaceEndpoint
+from langchain_community.document_loaders import TextLoader
+from langchain_text_splitters import RecursiveCharacterTextSplitter
+from langchain_community.vectorstores import FAISS
+from langchain_huggingface import HuggingFaceEndpointEmbeddings
+from langchain_core.prompts import PromptTemplate
+from langchain.schema.output_parser import StrOutputParser
+from langchain.schema.runnable import RunnablePassthrough
+from langchain.schema.runnable.config import RunnableConfig
+
+# GLOBAL SCOPE - ENTIRE APPLICATION HAS ACCESS TO VALUES SET IN THIS SCOPE #
+# ---- ENV VARIABLES ---- # 
+"""
+This function will load our environment file (.env) if it is present.
+
+NOTE: Make sure that .env is in your .gitignore file - it is by default, but please ensure it remains there.
+"""
+load_dotenv()
+
+"""
+We will load our environment variables here.
+"""
+HF_LLM_ENDPOINT = os.environ["HF_LLM_ENDPOINT"]
+HF_EMBED_ENDPOINT = os.environ["HF_EMBED_ENDPOINT"]
+HF_TOKEN = os.environ["HF_TOKEN"]
+
+# ---- GLOBAL DECLARATIONS ---- #
+
+# -- RETRIEVAL -- #
+"""
+1. Load Documents from Text File
+2. Split Documents into Chunks
+3. Load HuggingFace Embeddings (remember to use the URL we set above)
+4. Index Files if they do not exist, otherwise load the vectorstore
+"""
+### 1. CREATE TEXT LOADER AND LOAD DOCUMENTS
+### NOTE: PAY ATTENTION TO THE PATH THEY ARE IN. 
+text_loader = 
+documents = 
+
+### 2. CREATE TEXT SPLITTER AND SPLIT DOCUMENTS
+text_splitter = 
+split_documents = 
+
+### 3. LOAD HUGGINGFACE EMBEDDINGS
+hf_embeddings = 
+
+if os.path.exists("./data/vectorstore"):
+    vectorstore = FAISS.load_local(
+        "./data/vectorstore", 
+        hf_embeddings, 
+        allow_dangerous_deserialization=True # this is necessary to load the vectorstore from disk as it's stored as a `.pkl` file.
+    )
+    hf_retriever = vectorstore.as_retriever()
+    print("Loaded Vectorstore")
+else:
+    print("Indexing Files")
+    os.makedirs("./data/vectorstore", exist_ok=True)
+    ### 4. INDEX FILES
+    ### NOTE: REMEMBER TO BATCH THE DOCUMENTS WITH MAXIMUM BATCH SIZE = 32
+
+hf_retriever = vectorstore.as_retriever()
+
+# -- AUGMENTED -- #
+"""
+1. Define a String Template
+2. Create a Prompt Template from the String Template
+"""
+### 1. DEFINE STRING TEMPLATE
+RAG_PROMPT_TEMPLATE = 
+
+### 2. CREATE PROMPT TEMPLATE
+rag_prompt =
+
+# -- GENERATION -- #
+"""
+1. Create a HuggingFaceEndpoint for the LLM
+"""
+### 1. CREATE HUGGINGFACE ENDPOINT FOR LLM
+hf_llm = 
+
+@cl.author_rename
+def rename(original_author: str):
+    """
+    This function can be used to rename the 'author' of a message. 
+
+    In this case, we're overriding the 'Assistant' author to be 'Paul Graham Essay Bot'.
+    """
+    rename_dict = {
+        "Assistant" : "Paul Graham Essay Bot"
+    }
+    return rename_dict.get(original_author, original_author)
+
+@cl.on_chat_start
+async def start_chat():
+    """
+    This function will be called at the start of every user session. 
+
+    We will build our LCEL RAG chain here, and store it in the user session. 
+
+    The user session is a dictionary that is unique to each user session, and is stored in the memory of the server.
+    """
+
+    ### BUILD LCEL RAG CHAIN THAT ONLY RETURNS TEXT
+    lcel_rag_chain = 
+
+    cl.user_session.set("lcel_rag_chain", lcel_rag_chain)
+
+@cl.on_message  
+async def main(message: cl.Message):
+    """
+    This function will be called every time a message is recieved from a session.
+
+    We will use the LCEL RAG chain to generate a response to the user query.
+
+    The LCEL RAG chain is stored in the user session, and is unique to each user session - this is why we can access it here.
+    """
+    lcel_rag_chain = cl.user_session.get("lcel_rag_chain")
+
+    msg = cl.Message(content="")
+
+    async for chunk in lcel_rag_chain.astream(
+        {"query": message.content},
+        config=RunnableConfig(callbacks=[cl.LangchainCallbackHandler()]),
+    ):
+        await msg.stream_token(chunk)
+
+    await msg.send()

chainlit.md

@@ -0,0 +1 @@
+# FILL OUT YOUR CHAINLIT MD HERE WITH A DESCRIPTION OF YOUR APPLICATION

requirements.txt

@@ -0,0 +1,8 @@
+chainlit==0.7.700
+langchain==0.2.5
+langchain_community==0.2.5
+langchain_core==0.2.9
+langchain_huggingface==0.0.3
+langchain_text_splitters==0.2.1
+python-dotenv==1.0.1
+faiss-cpu

solution_app.py

@@ -0,0 +1,155 @@
+import os
+import chainlit as cl
+from dotenv import load_dotenv
+from operator import itemgetter
+from langchain_huggingface import HuggingFaceEndpoint
+from langchain_community.document_loaders import TextLoader
+from langchain_text_splitters import RecursiveCharacterTextSplitter
+from langchain_community.vectorstores import FAISS
+from langchain_huggingface import HuggingFaceEndpointEmbeddings
+from langchain_core.prompts import PromptTemplate
+from langchain.schema.output_parser import StrOutputParser
+from langchain.schema.runnable import RunnablePassthrough
+from langchain.schema.runnable.config import RunnableConfig
+
+# GLOBAL SCOPE - ENTIRE APPLICATION HAS ACCESS TO VALUES SET IN THIS SCOPE #
+# ---- ENV VARIABLES ---- # 
+"""
+This function will load our environment file (.env) if it is present.
+
+NOTE: Make sure that .env is in your .gitignore file - it is by default, but please ensure it remains there.
+"""
+load_dotenv()
+
+"""
+We will load our environment variables here.
+"""
+HF_LLM_ENDPOINT = os.environ["HF_LLM_ENDPOINT"]
+HF_EMBED_ENDPOINT = os.environ["HF_EMBED_ENDPOINT"]
+HF_TOKEN = os.environ["HF_TOKEN"]
+
+# ---- GLOBAL DECLARATIONS ---- #
+
+# -- RETRIEVAL -- #
+"""
+1. Load Documents from Text File
+2. Split Documents into Chunks
+3. Load HuggingFace Embeddings (remember to use the URL we set above)
+4. Index Files if they do not exist, otherwise load the vectorstore
+"""
+document_loader = TextLoader("./data/paul_graham_essays.txt")
+documents = document_loader.load()
+
+text_splitter = RecursiveCharacterTextSplitter(chunk_size=1000, chunk_overlap=30)
+split_documents = text_splitter.split_documents(documents)
+
+hf_embeddings = HuggingFaceEndpointEmbeddings(
+    model=HF_EMBED_ENDPOINT,
+    task="feature-extraction",
+    huggingfacehub_api_token=HF_TOKEN,
+)
+
+if os.path.exists("./data/vectorstore"):
+    vectorstore = FAISS.load_local(
+        "./data/vectorstore", 
+        hf_embeddings, 
+        allow_dangerous_deserialization=True # this is necessary to load the vectorstore from disk as it's stored as a `.pkl` file.
+    )
+    hf_retriever = vectorstore.as_retriever()
+    print("Loaded Vectorstore")
+else:
+    print("Indexing Files")
+    os.makedirs("./data/vectorstore", exist_ok=True)
+    for i in range(0, len(split_documents), 32):
+        if i == 0:
+            vectorstore = FAISS.from_documents(split_documents[i:i+32], hf_embeddings)
+            continue
+        vectorstore.add_documents(split_documents[i:i+32])
+    vectorstore.save_local("./data/vectorstore")
+
+hf_retriever = vectorstore.as_retriever()
+
+# -- AUGMENTED -- #
+"""
+1. Define a String Template
+2. Create a Prompt Template from the String Template
+"""
+RAG_PROMPT_TEMPLATE = """\
+<|start_header_id|>system<|end_header_id|>
+You are a helpful assistant. You answer user questions based on provided context. If you can't answer the question with the provided context, say you don't know.<|eot_id|>
+
+<|start_header_id|>user<|end_header_id|>
+User Query:
+{query}
+
+Context:
+{context}<|eot_id|>
+
+<|start_header_id|>assistant<|end_header_id|>
+"""
+
+rag_prompt = PromptTemplate.from_template(RAG_PROMPT_TEMPLATE)
+
+# -- GENERATION -- #
+"""
+1. Create a HuggingFaceEndpoint for the LLM
+"""
+hf_llm = HuggingFaceEndpoint(
+    endpoint_url=HF_LLM_ENDPOINT,
+    max_new_tokens=512,
+    top_k=10,
+    top_p=0.95,
+    temperature=0.3,
+    repetition_penalty=1.15,
+    huggingfacehub_api_token=HF_TOKEN,
+)
+
+@cl.author_rename
+def rename(original_author: str):
+    """
+    This function can be used to rename the 'author' of a message. 
+
+    In this case, we're overriding the 'Assistant' author to be 'Paul Graham Essay Bot'.
+    """
+    rename_dict = {
+        "Assistant" : "Paul Graham Essay Bot"
+    }
+    return rename_dict.get(original_author, original_author)
+
+@cl.on_chat_start
+async def start_chat():
+    """
+    This function will be called at the start of every user session. 
+
+    We will build our LCEL RAG chain here, and store it in the user session. 
+
+    The user session is a dictionary that is unique to each user session, and is stored in the memory of the server.
+    """
+
+    lcel_rag_chain = (
+        {"context": itemgetter("query") | hf_retriever, "query": itemgetter("query")}
+        | rag_prompt | hf_llm
+    )
+
+    cl.user_session.set("lcel_rag_chain", lcel_rag_chain)
+
+@cl.on_message  
+async def main(message: cl.Message):
+    """
+    This function will be called every time a message is recieved from a session.
+
+    We will use the LCEL RAG chain to generate a response to the user query.
+
+    The LCEL RAG chain is stored in the user session, and is unique to each user session - this is why we can access it here.
+    """
+    lcel_rag_chain = cl.user_session.get("lcel_rag_chain")
+
+    msg = cl.Message(content="")
+
+    for chunk in await cl.make_async(lcel_rag_chain.stream)(
+        {"query": message.content},
+        config=RunnableConfig(callbacks=[cl.LangchainCallbackHandler()]),
+    ):
+        await msg.stream_token(chunk)
+
+    await msg.send()