hugging face qa bot
v0.3
Un sistema de preguntas y respuestas de múltiples interfaz que utiliza la generación de Aumentados (RAG) de Hugging Face's y Recuperación para ofrecer respuestas basadas en la documentación de abrazos de Face. Operable como una aplicación API, Discord Bot o Gradio, también proporciona enlaces a la documentación utilizada para formular cada respuesta.
Para ejecutar cualquiera de las interfaces disponibles, especifique los parámetros requeridos en el archivo .env basado en el .env.example ubicado en el directorio config/ . Alternativamente, puede establecerlas como variables de entorno:
QUESTION_ANSWERING_MODEL_ID - (str) Una cadena que especifica la ID del modelo desde el concentrador de abrazadera o el directorio que contiene los pesos del modeloEMBEDDING_MODEL_ID - (STR) ID de modelo de incrustación del centro de la cara abrazada. Recomendamos usar el hkunlp/instructor-largeINDEX_REPO_ID - (STR) del centro de abrazadera donde se almacena el índice. La lista de los índices más reales se puede encontrar en esta sección: índicesPROMPT_TEMPLATE_NAME - (STR) Nombre de la plantilla de solicitud del modelo utilizada para responder a las preguntas, las plantillas se almacenan en el directorio config/api/prompt_templatesUSE_DOCS_FOR_CONTEXT - (bool) Use documentos recuperados como contexto para una consulta dadaNUM_RELEVANT_DOCS - (int) Número de documentos utilizados para la característica anteriorADD_SOURCES_TO_RESPONSE - (bool) Incluya fuentes de los documentos recuperados utilizados como contexto para una consulta dadaUSE_MESSAGES_IN_CONTEXT - (bool) Use el historial de chat para la experiencia de conversaciónDEBUG - (bool) proporciona registro adicionalInstale las dependencias necesarias en el archivo de requisitos:
pip install -r requirements.txt Después de completar todos los pasos descritos en la sección Configuración, especifique la variable de entorno APP_MODE como gradio y ejecute el siguiente comando:
python3 app.py Por defecto, la API se sirve en http://0.0.0.0:8000 . Para iniciarlo, complete todos los pasos descritos en la sección Configuración, luego ejecute el siguiente comando:
python3 -m api Para interactuar con el sistema como un bot de discordia, agregue variables de entorno requeridas adicionales de la sección Discord bot del archivo .env.example en el directorio config/ .
DISCORD_TOKEN - (STR) Clave API para la aplicación BOTQA_SERVICE_URL - (STR) URL del servicio API. Recomendamos usar: http://0.0.0.0:8000NUM_LAST_MESSAGES - (int) Número de mensajes utilizados para el contexto en conversacionesUSE_NAMES_IN_CONTEXT - (bool) Incluya nombres de usuario en el contexto de conversaciónENABLE_COMMANDS - (bool) Permitir comandos, por ejemplo, limpieza de canalesDEBUG - (bool) proporciona registro adicionalDespués de completar todos los pasos, ejecute:
python3 -m bot Para alojar el bot en los espacios faciales para abrazar, especifique la variable de entorno APP_MODE como discord , y el BOT se ejecutará automáticamente desde el archivo app.py
La siguiente lista contiene los índices más actuales que se pueden usar para el sistema:
Usamos Python 3.10
Para instalar todos los paquetes de Python necesarios, ejecute el siguiente comando:
pip install -r requirements.txtUtilizamos el PIPREQSNB para generar el archivo requisitos.txt. Para instalar pipreqsnb, ejecute el siguiente comando:
pip install pipreqsnbPara generar el archivo requisitos.txt, ejecute el siguiente comando:
pipreqsnb --force .Para ejecutar pruebas unitarias, puede usar el siguiente comando:
pytest -o " testpaths=tests " --noconftest
