Ed Tech Company QA Assistant

Asistente de control de calidad

Este proyecto es un asistente de control de calidad (preguntas respetuosas) diseñada para una empresa Ed-Tech. Aprovecha las bases de datos de vectores, los modelos de lenguaje de última generación y las integridades de documentos personalizados para proporcionar respuestas precisas a las consultas de los usuarios basadas en una base de conocimiento predefinida.

Tabla de contenido

• Características
• Instalación
• Uso
• Estructura de proyectos
• Mejoras futuras
• Que contribuye
• Licencia

Características

• Base de datos vectorial : utiliza FAISS para una búsqueda de similitud eficiente en la base de conocimiento.
• Incruscaciones personalizadas : alimentado por HuggingFaceEmbeddings utilizando el modelo de transformadores de oración/All-Minilm-L6-V2.
• Modelo de lenguaje grande (LLM) : integra el modelo LLAMA3 de Groq (LLAMA3-8B-8192) para generar respuestas con el contexto.
• Cargador CSV : carga las preguntas frecuentes u otros datos estructurados de los archivos CSV para completar la base de conocimiento.
• Interfaz de transmisión : una interfaz de usuario simple e interactiva para hacer preguntas y recibir respuestas.

Instalación

1. Clon el repositorio:

 git clone https : // github . com / shaadclt / Ed - Tech - Company - QA - Assistant . git
cd Ed - Tech - Company - QA - Assistant

2. Configurar un entorno virtual:

 python - m venv venv
source venv / bin / activate  # On Windows, use `venvScriptsactivate`

3. Instalar dependencias:

 pip install - r requirements . txt

4. Variables de entorno: cree un archivo .env en la raíz del proyecto y agregue su tecla API Groq:

 GROQ_API_KEY = your_groq_api_key_here 

Uso

1. Ejecute la aplicación Streamlit

 streamlit run main . py

2. Cree la base de conocimiento: para crear la base de conocimiento a partir de un archivo CSV, haga clic en el botón Crear basura de conocimiento

3. Haga una pregunta: ingrese una pregunta en la interfaz de transmisión, y el asistente proporcionará una respuesta contextualmente precisa basada en la base de conocimiento cargada.

Estructura de proyectos

• langchain_helper.py : contiene la lógica para cargar datos, crear la base de datos vectorial y generar respuestas.
• Main.py : el archivo de aplicación Streamlit.
• FAQS.CSV : un archivo CSV de muestra utilizado para completar la base de conocimiento.
• requisitos.txt : enumera todos los paquetes de Python requeridos.
• .env : almacena variables de entorno como claves API (no incluidas en el repositorio por razones de seguridad).

Mejoras futuras

• Expandir la base de conocimiento: agregue más documentos o fuentes de datos.
• Modelos de ajuste fino: ajuste los incrustaciones o LLM para obtener respuestas más precisas.
• UI avanzada: Mejore la interfaz de transmisión con características adicionales como el filtrado de respuesta o los mecanismos de retroalimentación.

Que contribuye

Siéntase libre de desembolsar este repositorio, crear una rama de características y enviar una solicitud de extracción de cualquier mejoramiento o solución de errores.

Licencia

Este proyecto tiene licencia bajo la licencia MIT. Consulte el archivo de licencia para obtener más detalles.