chat_with_your_docs

título	emoji	color de color	colorto	sdk	sdk_version	app_file	cubierto	licencia
Chatea con tus documentos		azul	gris	Gradio	4.41.0	app.py	FALSO	MIT

Chatea con tus documentos

Introducción

---

La aplicación de chat de chatwithyourdocs es una aplicación de Python que le permite chatear con múltiples formatos de documentos como PDF, páginas web y videos de YouTube. Puede hacer preguntas sobre los PDF utilizando lenguaje natural, y la aplicación proporcionará respuestas relevantes basadas en el contenido de los documentos. Esta aplicación utiliza un modelo de idioma para generar respuestas precisas a sus consultas. Tenga en cuenta que la aplicación solo responderá a las preguntas relacionadas con los documentos cargados.

Cómo funciona

---

La aplicación sigue estos pasos para proporcionar respuestas a sus preguntas:

1. Carga de doc: la aplicación lee múltiples tipos de documentos y extrae su contenido de texto.

2. Chounking de texto: el texto extraído se divide en trozos más pequeños que se pueden procesar de manera efectiva.

3. Modelo de lenguaje: la aplicación utiliza un modelo de idioma para generar representaciones vectoriales (incrustaciones) de los fragmentos de texto.

4. COCESA DE SIMILIDAD: cuando hace una pregunta, la aplicación la compara con los trozos de texto e identifica los más semánticamente similares.

5. Generación de respuesta: los fragmentos seleccionados se pasan al modelo de idioma, que genera una respuesta basada en el contenido relevante de los documentos.

Dependencias e instalación

---

Para instalar el chat con su aplicación Docs, siga estos pasos:

1. Descargar la biblioteca Ollama

    curl https://ollama.ai/install.sh | sh
   

2. Tire de los modelos de chat que usaremos, en este caso usaremos LLAMA2, Mistral y Gemma

    ollama pull llama2
   

    ollama pull mistral
   

    ollama pull gemma
   

3. Cree un nuevo entorno con Python 3.9 y activelo, en este caso usaremos conda

    conda create -n cwd python=3.9
   

    conda activate cwd
   

4. Clonar el repositorio de su máquina local.

    git clone https://github.com/jorge-armando-navarro-flores/chat_with_your_docs.git
   

    cd chat_with_your_docs
   

5. Instale las dependencias requeridas ejecutando el siguiente comando:

    pip install -r requirements.txt
   

6. Instale FFMPEG para videos de YouTube:

    sudo apt-get install ffmpeg
   

Uso

---

Para usar el chat con su aplicación Docs, siga estos pasos:

1. Ejecute el archivo main.py utilizando la CLI optimista. Ejecutar el siguiente comando:

    python3 main.py
   

2. La aplicación se iniciará en su navegador web predeterminado, mostrando la interfaz de usuario.

Arquitectura

Clases:

• LLM: Esta clase abstracta sirve como un plan para diferentes implementaciones de LLM. Tiene subclases como OllamaModel , OpenAIModel y HFModel que manejan proveedores específicos de LLM (Ollama, OpenAi y abrazando la cara).
• Docios: Esta clase gestiona la carga de documentos de varias fuentes como PDF, páginas web y videos de YouTube.
• VectorStore: esta clase crea una representación vectorial de los documentos utilizando incrustaciones de LLM para una recuperación eficiente.
• Cadena: esta clase define la tubería de procesamiento para el chatbot. Puede ser una cadena simple para la respuesta básica de preguntas o una cadena de recuperación que busca documentos basados ​​en el historial de conversación.
• ChatBot: Esta clase maneja la interacción del usuario, mantiene el historial de conversación y llama al método de cadena apropiado para generar respuestas.
• ChatBotController: esta clase es la interfaz principal para el usuario. Permite configurar el modelo LLM, la fuente de documentos y las opciones de recuperación. También maneja consultas de usuarios e interactúa con la instancia de chatbot.

Funcionalidad:

1. Configuración:

   • El usuario selecciona el proveedor de LLM (Ollama, OpenAI o Huggingface) y modela desde un menú desplegable. Opcionalmente, podría ser necesaria una clave API para ciertos proveedores.
   • El usuario puede elegir agregar documentos (PDF, URL de la página web o URL de video de YouTube) para tareas de recuperación.

2. Tratamiento:

   • Basado en el LLM y los documentos elegidos (si los hay), el controlador configura la cadena de procesamiento.
   • Se utiliza una cadena simple para responder a preguntas básicas sin recuperación de documentos.
   • Una cadena de recuperación implica:
     • Creación de una representación vectorial de los documentos utilizando los incrustaciones de la LLM.
     • Definición de indicaciones para generar consultas de búsqueda basadas en el historial de conversación.
     • Recuperación de documentos relevantes basados ​​en las consultas generadas.
     • Uso de los documentos recuperados para responder a la pregunta del usuario.

3. Interacción:

   • El usuario escribe sus preguntas en la interfaz de chat.
   • El controlador llama al método predict del chatbot, aprobando la consulta del usuario y el historial de conversación (si la recuperación está habilitada).
   • El chatbot recupera la respuesta apropiada basada en la configuración de la cadena elegida.

Características adicionales:

• La interfaz incluye botones para el historial de conversación "deshacer" y "claro".

En general, este código demuestra una arquitectura bien estructurada para un chatbot que puede aprovechar diferentes LLM e incorporar la recuperación de documentos para mayores capacidades.