Welcome to the SEERAH BOT repository! SEERAH BOT is an interactive chatbot designed to assist users in exploring historical texts and retrieving information related to the life of the Holy Prophet Muhammad (P.B.U.H) and everything related to his SEERAH. It is developed as part of the project "Muslims On Mission", which aims to utilize AI technologies to empower users with knowledge about Islamic history, teachings, and culture.
"Muslims On Mission" is a project dedicated to leveraging AI technologies to educate and inform users about Islamic history, teachings, and culture. SEERAH BOT, as a part of this project, focuses specifically on providing an interactive platform where users can engage with historical texts related to the life of the Holy Prophet Muhammad (P.B.U.H). The bot aims to provide accurate information, facilitate learning, and deepen the understanding of users about the SEERAH of the Prophet Muhammad (P.B.U.H).
SEERAH BOT offers an intuitive chat interface powered by Streamlit, allowing users to engage in conversations seamlessly. The chat interface mimics human-like interactions, making it easy and enjoyable for users to interact with the bot.
SEERAH BOT is equipped with text analysis capabilities that enable it to process user queries, extract relevant information from historical texts, and provide accurate responses. Users can ask questions, seek clarification, or request information on various aspects of the SEERAH.
To ensure credibility and proper attribution, SEERAH BOT automatically generates citations for referenced texts and annotations. This feature enhances the reliability of the provided information and allows users to trace back the sources for further verification.
SEERAH BOT leverages OpenAI's Assistants API to enhance its conversational abilities and access advanced AI functionalities. The integration enables the bot to understand user queries better, generate coherent responses, and provide insightful information from a vast repository of historical texts.
SEERAH BOT is an open-source project, welcoming contributions from developers, researchers, and enthusiasts interested in Islamic history and AI technologies. Contributors can suggest improvements, add new features, or contribute to the development of the project to enhance its capabilities and reach.
To start using SEERAH BOT, follow these simple steps:
-
Clone the Repository: Clone this repository to your local machine using
git clone https://github.com/your-username/seerah-bot.git -
Install Dependencies: Navigate to the project directory and install the required dependencies using
pip install -r requirements.txt -
Set up OpenAI API Key: Obtain an API key from OpenAI and add it to the
.envfile in the project directory. -
Run the Application: Launch the Streamlit application by running
streamlit run app.pyin your terminal. Access the bot interface in your web browser.
It is part of the "Muslims On Mission" project, dedicated to leveraging technology for educational purposes in Islamic studies.
For more information and detailed documentation, please refer to the project documentation or contact the project maintainers. Thank you for your interest in SEERAH BOT!