updates

appendix/description.txt

@@ -0,0 +1,75 @@
+# Medical  Interviewer
+This chatbot conducts medical interviews based on psychological knowledge.
+
+The interviewer will prepare a medical report based on the interview.
+
+* Please note that this is a simulation and should not be used as a substitute for professional medical advice.
+* It is important to emphasize that any information shared is confidential and cannot be accessed. 
+* In any case, it is recommended not to share sensitive information.
+
+
+**Medical  Interviewer** is an AI platform designed to simulate medical interviews. It leverages NLP and speech technologies to emulate a medical psychologist, offering insightful assessments and generating detailed medical reports. 
+
+This platform is ideal for educational, research, and preliminary assessment purposes but should not replace professional medical advice.
+
+## Features
+
+**Key Features**:
+- **Simulated Interviews**: Conducts interviews with focused medically relevant questions.
+- **Natural Language Processing**: Understands and generates contextually relevant questions.
+- **LangChain**: Create NLP chains for interview and report generation.
+- **Audio Interaction**: Voice conversation simulation where the user can talk to the bot in a way that simulates real conversation or evidence.
+- **Report Generation**: Automatically creates comprehensive medical reports after each session.
+- **Document Upload for Reports**: Generates reports from uploaded TXT, PDF, or DOCX files.
+- **Multi-language Support**: Conducts interviews and generates reports in the user's preferred language.
+- **Selectable Interviewers**: Users can select their preferred interviewer, each with a different professional background, experience, and temperament. Options include:
+    - Sarah: An empathic, compassionate medical with over 30 years of experience, specializing in trauma, anxiety disorders, and family therapy.
+    - Aaron: A tough minded, medical with over 15 years of experience, specializing in stress, trauma, and high-performance demands, with a background as a military officer.
+
+
+## Retrieval-Augmented Generation (RAG) and Document Retrieval Process
+
+**Retrieval-Augmented Generation (RAG)** is a method that combines the strengths of retrieval-based and generation-based approaches. RAG helps to ensure that the interview questions generated by the AI are both contextually relevant and grounded in authoritative sources - This optimizes and reduces the response time.
+
+1. **Document Embeddings**: The documents are converted into embeddings using OpenAI’s embedding models. These embeddings capture the semantic meaning of the text and are used to facilitate efficient retrieval.
+2. **FAISS Indexing**: The embeddings are stored in a FAISS (Facebook AI Similarity Search) index. FAISS is optimized for similarity search and clustering of dense vectors, making it ideal for this purpose.
+3. **Query Embedding**: When a user input or interview context is provided, it is also converted into an embedding.
+4. **Similarity Search**: The query embedding is used to search the FAISS index to retrieve the most relevant documents based on their embeddings.
+5. **Top-K Retrieval**: The system retrieves the top-K documents that are most similar to the user’s query embedding. These documents are then used to generate the next interview question, ensuring that the responses are based on relevant and accurate information.
+
+## Documents and Knowledge Database
+
+The platform uses a rich set of documents and knowledge bases to inform the AI’s questioning and reporting processes. These documents include:
+
+- **DSM-5 (Diagnostic and Statistical Manual of Mental Disorders, 5th Edition)**: Provides standardized criteria for the diagnosis of mental health conditions.
+- **PDM-2 (Psychodynamic Diagnostic Manual, 2nd Edition)**: Offers a psychodynamic perspective on mental health diagnosis.
+- **Personalities Descriptions**: Detailed descriptions of various personality types and traits.
+- **Defence Mechanisms**: Information on psychological strategies used by individuals to cope with reality and maintain self-image.
+- **Big Five Traits**: Descriptions of the five-factor model of personality traits.
+- **Attachment Styles**: Framework for understanding different types of attachment in interpersonal relationships.
+- **Interview Conduction Guides for medical Psychologists**: Guidelines and best practices for conducting medical interviews.
+
+These documents are processed and indexed, enabling the AI to retrieve relevant excerpts during the interview to generate questions that are grounded in established psychological knowledge.
+
+## Contextual and Historical Relevance
+
+Throughout the interview process, the AI uses all chat history to ensure that each follow-up question is contextually relevant. By leveraging both the immediate user input and the full history of the conversation, the AI can provide a coherent and comprehensive interview experience. The use of RAG ensures that the follow-up questions are informed not only by the user's previous responses but also by the most relevant and authoritative information available in the knowledge base.
+
+## Human-like simulated environment 
+It supports audio interactions by converting text questions into speech and transcribing user audio responses into text, facilitated by OpenAI’s text-to-speech (TTS) and Whisper speech-to-text technologies. This creates a simulated environment for real-like conversational interviews, making the interactions more human-like.
+
+### Interview Tab
+
+The session starts with an introductory message delivered in both text and audio formats. Users respond by typing or recording audio responses, which the AI processes to generate and return relevant follow-up questions based on context and the retrieved documents. The conversation continues until a predetermined number of questions have been asked. At the end of the session, a detailed medical report is generated and available for download as a PDF.
+
+### Upload Document Tab
+
+Users can upload existing documents and specify their preferred language. The system analyzes the document content and generates a detailed medical report, which can be displayed and downloaded.
+
+## Disclaimer
+
+This platform is a simulation and should not replace professional medical advice. Always seek advice from a qualified healthcare provider for medical concerns.
+
+---
+
+**medical Interviewer ** stands as a testament to the potential of advanced AI technologies in simulating medical psychology interviews and generating detailed reports. For technical details, refer to the in-code documentation. This platform offers a valuable tool for educational and research purposes by providing an enriching and interactive user experience.