{"id":23962988,"url":"https://github.com/gkamboj/finance-gpt","last_synced_at":"2026-04-09T02:30:57.712Z","repository":{"id":261129992,"uuid":"882704540","full_name":"gkamboj/finance-gpt","owner":"gkamboj","description":"Streamlit based Gen AI chatbot that allows users to get answers to queries related to financial documents.","archived":false,"fork":false,"pushed_at":"2024-12-28T14:51:47.000Z","size":476,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-08T09:04:47.585Z","etag":null,"topics":["analytics","cloud-foundry","csv-files","genai-chatbot","langchain","openai","python","rag","sap-btp","streamlit","text-embedding"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gkamboj.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-11-03T14:45:15.000Z","updated_at":"2024-12-28T15:33:26.000Z","dependencies_parsed_at":"2024-12-28T15:24:20.322Z","dependency_job_id":"db293925-3592-4daf-8393-12b6c1cb49ff","html_url":"https://github.com/gkamboj/finance-gpt","commit_stats":null,"previous_names":["gkamboj/finance-gpt"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gkamboj/finance-gpt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gkamboj%2Ffinance-gpt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gkamboj%2Ffinance-gpt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gkamboj%2Ffinance-gpt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gkamboj%2Ffinance-gpt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gkamboj","download_url":"https://codeload.github.com/gkamboj/finance-gpt/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gkamboj%2Ffinance-gpt/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31582537,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"online","status_checked_at":"2026-04-09T02:00:06.848Z","response_time":112,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analytics","cloud-foundry","csv-files","genai-chatbot","langchain","openai","python","rag","sap-btp","streamlit","text-embedding"],"created_at":"2025-01-06T20:59:02.930Z","updated_at":"2026-04-09T02:30:57.695Z","avatar_url":"https://github.com/gkamboj.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# finance-gpt\n\nFinance GPT is a generative AI chatbot built on [Streamlit](https://streamlit.io/) that effectively addresses user queries by utilizing a vector-based document database. It allows users to get answers to queries related to any financial documents such as annual reports of listed companies or CSV/Excel of their financial figures. By employing the Retrieval-Augmented Generation (RAG) framework, uploaded document serve as context for generating responses through a large language model (LLM) using [LangChain](https://www.langchain.com/).\n\n## Table of Contents\n- [Setup Instructions](#setup-instructions)\n- [Usage](#usage)\n- [Screenshots](#screenshots)\n- [Customizations](#customizations)\n- [Deployment](#deployment)\n- [Contributing](#contributing)\n- [License](#license)\n\n\n## Setup Instructions\n\nAfter cloning the repository, follow these steps to set up the project:\n\n1. **Set Up your development environment**:\n   - Download and install JetBrains PyCharm IDE or your preferred IDE.\n   - The following instructions will focus on PyCharm, but most IDEs provide similar features.\n\n2. **Open the project**:\n   - In PyCharm, navigate to `File -\u003e Open` and select the cloned repository folder.\n\n3. **Set Up a local virtual environment**:\n   - Go to `Settings` \u003e `Project: finance-gpt` \u003e `Python Interpreter` \u003e `Add Interpreter`.\n   - Choose `Add Local Interpreter` \u003e `Virtualenv Environment`.\n     1. Select `Environment` -\u003e `New`.\n     2. Set `Base Interpreter` to your installed Python version (e.g., Python 3.x).\n     3. Click `OK`.\n\n4. **Install dependencies**:\n   - Run the following commands in your terminal:\n     ```bash\n     pip install \"generative-ai-hub-sdk[all]==1.2.2\" --extra-index-url https://int.repositories.cloud.sap/artifactory/api/pypi/proxy-deploy-releases-hyperspace-pypi/simple/\n     pip install -r requirements.txt\n     ```\n   - If you prefer to connect directly to the LLM via OpenAI instead of using the SAP proxy, you can skip the installation of `generative-ai-hub-sdk` and install required LangChain libraries instead.\n\n5. **Run the application**:\n   ```bash\n   streamlit run finance-gpt.py\n   ```\n   \n6. **Access the user interface**:\nOpen your web browser and navigate to [http://localhost:8500/](http://localhost:8500/) (or the appropriate port if different).\n\n## Usage\nOnce the application is running, you can interact with finance-gpt by uploading your file and entering your in the selected interface. The chatbot will retrieve relevant information from the document and generate responses based on the context.\n\n## Screenshots\nHere are some screenshots showcasing working deployments of the application.\n- Chat inteerface selection:\n\u003cimg width=\"679\" alt=\"1-interaction-types\" src=\"https://github.com/user-attachments/assets/6f463af0-ad00-4584-a31c-105a359f574f\"\u003e\n\n\n- _PDF_ interaction type:\n\u003cimg width=\"1713\" alt=\"2-pdf-1\" src=\"https://github.com/user-attachments/assets/9a274f53-8780-4290-bc36-ff7016930157\"\u003e\n\n\u003cimg width=\"1727\" alt=\"3-pdf-2\" src=\"https://github.com/user-attachments/assets/da7670dd-82f4-4558-b39a-8e5f4546d3c0\"\u003e\n\n\n- _EXCEL_ interaction type:\n\u003cimg width=\"1727\" alt=\"4-csv-line\" src=\"https://github.com/user-attachments/assets/7948e12f-eaac-4f03-85c3-7e7b3b36fea9\"\u003e\n\n\u003cimg width=\"1171\" alt=\"5-csv-bar\" src=\"https://github.com/user-attachments/assets/5d351761-fc3b-4e59-9a97-66c8f10f01af\"\u003e\n\n\n## Customizations\nYou can easily customize the application in the following ways:\n- Financial documents are just a use case for the RAG, same application can be generalised to query any kind of PDFs and CSVs.\n- Modify the `properties.yml` file to adjust various flags and properties (e.g., enabling calls to the LLM without context if call with context does not give relevant response) to suit your requirements.\n\n## Deployment\nHere are a few options for deploying the application:\n- [Streamlit Community Cloud](https://share.streamlit.io/deploy)\n- Cloud Foundry: Relevant files for deployment through SAP BTP are included in the repository.\n\n\n## Contributing\nWe welcome contributions to enhance finance-gpt! Please fork the repository and submit a pull request for any new features or bug fixes.\n\n## License\nThis project is licensed under the MIT License. See the LICENSE file for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgkamboj%2Ffinance-gpt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgkamboj%2Ffinance-gpt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgkamboj%2Ffinance-gpt/lists"}