README.md

metadata

title: Compass FSS Advisor
emoji: 🏠
colorFrom: blue
colorTo: purple
sdk: docker
app_file: app.py
pinned: false

Compass FSS Advisor

Compass Working Capital is committed to enhancing the support provided to organizations adopting the Family Self-Sufficiency (FSS) program model. To achieve this, Compass has partnered with Ascend Impact Advisors (www.ascendimpactadvisors.com) to develop and test prototypes of custom AI Agents capable of efficiently and accurately respond to queries related to the FSS program, encompassing HUD rules and regulations, and Compass’s evidence-based program model. It is intended for use by Compass staff and Compass FSS Link members under the guidance of trained Compass program staff.

The application leverages Chainlit, LangChain, OpenAI, and Qdrant to perform retrieval-augmented generation (RAG) on its knowledge base.

Features

• Document Loading: Loads and splits a PDF document into manageable chunks.
• Embeddings and Retrieval: Uses OpenAI embeddings and Qdrant for efficient document retrieval.
• Question Answering: Answers questions based on the context retrieved from the document.
• Chainlit Integration: Provides a chat interface for users to interact with the application.

Setup

To set up and run the application locally, follow these steps:

1. Clone the repository: git clone https://huggingface.co/spaces/sampazar/midterm-app cd midterm-app
2. Build and run the Docker container: docker build -t midterm-app . docker run -p 7860:7860 midterm-app

Requirements

Make sure you have the following dependencies installed if you are not using Docker: Python 3.9 pip

Dependencies

The application depends on several Python packages, which are listed in the requirements.txt file. You can install them using: pip install -r requirements.txt

Usage

Run the application with: chainlit run app.py --port 7860

Once the application is running, you can access it in your browser at http://localhost:7860.

Disclaimer

The beta software, tool, product, feature and services (“Beta”) licensed hereunder is still in the testing phase and is provided on an “as is” and “as available” basis and may contain defects, inaccuracies and limited security protections. The primary purpose of this beta testing is to obtain feedback on the Beta software’s performance, services and the identification of defects. You are advised to safeguard important data, to use caution and not to rely in any way on the correct functioning or performance of the Beta and/or accompanying materials. Do not enter any sensitive or confidential information into the Beta. Ascend Impact Advisors expressly disclaims any responsibility for the security of any user information that you enter into the Beta. Any downloading or uploading of material to the Beta is done at your own risk and you will be solely responsible for any damage to any computer system or loss of data that results from such activities. Ascend Impact Advisors may modify or discontinue the Beta or any parts thereof at any time in its sole discretion. Neither Ascend Impact Advisors nor its respective officers, directors, members, employees or agents will have any liability for any harm or damage arising out of or in connection with limiting or removing your access to or use of the Beta or any parts thereof.

License

Contact Compass Working Capital for details.