Skip to content

RAG_Assistant.md

Latest commit

 

History

History
49 lines (35 loc) · 2.23 KB

RAG_Assistant.md

File metadata and controls

49 lines (35 loc) · 2.23 KB

Creating a RAG assistant

You can build a RAG assistant using a Chroma database.

Setting up Chroma

To create a Chroma database:

  1. Add the data you want to use to a folder, i.e. ./data, Word and PDF files are currently supported.
  2. Open create_chroma_db.py file and set the folder_path variable to the path to your data i.e. ./data.
  3. You can change the database name, chunk size and overlap size.
  4. Assuming you have already followed the Quickstart and activated the virtual environment, to create the database run:
python scripts/create_chroma_db.py
  1. If successful, a Chroma db will be created in the repository root directory.

Configuring the RAG assistant

To create a RAG assistant:

  1. Open tools.py file and make sure the persist_directory is pointing to the database you created previously.
  2. Modify the amount of documents returned, currently set to 5.
  3. Update the database_search_func function description to accurately describe what the purpose and contents of your database is.
  4. Open rag_assistant.py file and update the agent's instuctions to describe what the assistant's speciality is and what knowledge it has access to, for example:
instructions = f"""
    You are a helpful HR assistant with the ability to search a database containing information on our company's policies, benefits and handbook.
    Today's date is {current_date}.

    NOTE: THE USER CAN'T SEE THE TOOL RESPONSE.

    A few things to remember:
    - If you have access to multiple databases, gather information from a diverse range of sources before crafting your response.
    - Please include the source of the information used in your response.
    - Use a friendly but professional tone when replying.
    - Only use information from the database. Do not use information from outside sources.
    """
  1. Open streamlit_app.py file and update the agent's welcome message:
WELCOME = """Hello! I'm your AI-powered HR assistant, here to help you navigate company policies, the employee handbook, and benefits. Ask me anything!""
  1. Run the application and test your RAG assistant.