Updated Readme

README.md

@@ -21,7 +21,7 @@ PharmAssistAI revolutionizes how pharmacy professionals and students approach le
 - **Interactive Learning**: Engage with AI-generated related questions to deepen understanding and knowledge retention.
 - **Research Linkage**: Automatically fetch and link relevant academic papers from PubMed, enhancing the depth of available information and supporting academic research.
 
-## Advanced Capabilities
+## Monitoring and Evaluation
 
 - **Real-Time Feedback with LangSmith**: Use LangSmith to incorporate real-time feedback and custom evaluations. This system ensures that the AI's responses are not only accurate but also contextually aware and user-focused.
 - **Custom Evaluators for Enhanced Accuracy**: Deploy custom evaluators like PharmAssistEvaluator to ensure responses meet high standards of relevance, safety, and perception as human-generated versus AI-generated.
@@ -31,9 +31,14 @@ PharmAssistAI revolutionizes how pharmacy professionals and students approach le
 1. **Query Input**: Pharmacists type in their questions directly.
 2. **Data Retrieval**: Relevant data is fetched from comprehensive datasets, including automated searches of PubMed for related academic papers.
 3. **Data Presentation**: Data is displayed in an easily digestible format.
-4. **Summary Generation**: Summaries of the data are created using GenAI technologies.
+4. **Summary Generation**: Summaries of the data are created using GenAI
 5. **Question Suggestion**: Suggest related questions to encourage further exploration.
 
+## Architecture
+
+![RAG Architecture](https://i.imgur.com/QPNipiI.png)
+
+
 ## Hugging Face App Demo
 
 
@@ -64,7 +69,6 @@ Explore the effectiveness and interaction tracking of LangSmith in PharmAssistAI
 ![Metrics Dashboard](https://i.imgur.com/H9Q8OKj.png)
 
 
-
 ## Development Roadmap
 
 - Integrate and index the complete FDA Drug Labeling and Adverse Events datasets.
@@ -81,6 +85,4 @@ Simply enter your question about any FDA-approved drug in our chat interface, an
 We value your input and invite you to help us enhance PharmAssistAI:
 
 - 🐛 [Report an issue](https://github.com/rajkstats/pharmassistai/issues) on GitHub for technical issues or feature suggestions.
-- 📧 Contact us at [[email protected]](mailto:[email protected]) for direct support or inquiries.
-
-Join us in transforming pharmaceutical research and education through advanced AI technology!
+- 📧 Contact us at [[email protected]](mailto:[email protected]) for direct support or inquiries.

chainlit.md

@@ -10,7 +10,7 @@ PharmAssistAI revolutionizes how pharmacy professionals and students approach le
 - **Interactive Learning**: Engage with AI-generated related questions to deepen understanding and knowledge retention.
 - **Research Linkage**: Automatically fetch and link relevant academic papers from PubMed, enhancing the depth of available information and supporting academic research.
 
-## Advanced Capabilities
+## Monitoring and Evaluation
 
 - **Real-Time Feedback with LangSmith**: Use LangSmith to incorporate real-time feedback and custom evaluations. This system ensures that the AI's responses are not only accurate but also contextually aware and user-focused.
 - **Custom Evaluators for Enhanced Accuracy**: Deploy custom evaluators like PharmAssistEvaluator to ensure responses meet high standards of relevance, safety, and perception as human-generated versus AI-generated.
@@ -20,9 +20,15 @@ PharmAssistAI revolutionizes how pharmacy professionals and students approach le
 1. **Query Input**: Pharmacists type in their questions directly.
 2. **Data Retrieval**: Relevant data is fetched from comprehensive datasets, including automated searches of PubMed for related academic papers.
 3. **Data Presentation**: Data is displayed in an easily digestible format.
-4. **Summary Generation**: Summaries of the data are created using GenAI technologies.
+4. **Summary Generation**: Summaries of the data are created using GenAI
 5. **Question Suggestion**: Suggest related questions to encourage further exploration.
 
+## Architecture
+
+![RAG Architecture](https://i.imgur.com/QPNipiI.png)
+
+
+
 ## Hugging Face App Demo
 
 
@@ -69,6 +75,4 @@ Simply enter your question about any FDA-approved drug in our chat interface, an
 We value your input and invite you to help us enhance PharmAssistAI:
 
 - 🐛 [Report an issue](https://github.com/rajkstats/pharmassistai/issues) on GitHub for technical issues or feature suggestions.
-- 📧 Contact us at [[email protected]](mailto:[email protected]) for direct support or inquiries.
-
-Join us in transforming pharmaceutical research and education through advanced AI technology!
+- 📧 Contact us at [[email protected]](mailto:[email protected]) for direct support or inquiries.

fda-drugs-indexer/main.py

@@ -1,13 +1,28 @@
+# Set up a Python virtual environment and activate it:
 # python3 -m venv myenv
 # source myenv/bin/activate
+
+# Run the FastAPI application with live reload for development:
 # uvicorn main:app --reload
+
+# Run the FastAPI application in the background for production:
 # nohup uvicorn main:app --host 0.0.0.0 --port 8000 &
+
+# Check which process is using a specific port (8000 in this case):
 # lsof -i :8000
+
+# Terminate a process using a specific port by its PID (e.g., PID 2540):
 # kill -9 2540
-# you can call this endpoint from Postman (or any other HTTP client) by sending a POST request to http://your_server_url/index_fda_drugs?url=https://download.open.fda.gov/drug/label/drug-label-0001-of-0012.json.zip, where the URL is passed as a query parameter.
-# Local: http://127.0.0.1:8000/index_fda_drugs?url=https://download.open.fda.gov/drug/label/drug-label-0001-of-0012.json.zip
+
+# Example of a POST request from Postman or any other HTTP client:
+# This request indexes data from a specified URL:
+# You can call this endpoint by sending a POST request to:
+# http://your_server_url/index_fda_drugs?url=https://download.open.fda.gov/drug/label/drug-label-0001-of-0012.json.zip
+# where the URL is passed as a query parameter.
+
+# Examples for testing the endpoint locally using curl:
+# Local URL testing with curl:
 # curl -X POST "http://127.0.0.1:8000/index_fda_drugs?url=https://download.open.fda.gov/drug/label/drug-label-0001-of-0012.json.zip"
-# curl --interface <network_interface> -X POST "http://0.0.0.0:8000/index_fda_drugs?url=https://download.open.fda.gov/drug/label/drug-label-0001-of-0012.json.zip"
 
 import asyncio
 import time