chat with your doc

chat-with tu doc

chat-with-your-doc es una aplicación de demostración que aprovecha las capacidades de ChatGPT/GPT-4 y Langchain para permitir a los usuarios chatear con sus documentos. Este repositorio aloja la base de código, las instrucciones y los recursos necesarios para configurar y ejecutar la aplicación.

Introducción

El objetivo principal de este proyecto es simplificar la interacción con los documentos y extraer información valiosa con el uso del lenguaje natural. Este proyecto se construye con Langchain y GPT-4/CHATGPT para ofrecer una experiencia de conversación suave y natural al usuario, con soporte tanto para Azure OpenAI Services como para OpenAI

Actualizaciones

• 20230709: Agregar soporte para la API de Operai
• 20230703: Web UI cambió a Strewlit, con soporte para la transmisión

Características

• Cargue documentos como base de conocimiento externo para GPT-4/CHATGPT, admite Azure OpenAI Services y OpenAI
• Admite varios formatos, incluidos PDF, DOCX, PPTX, TXT, etc.
• Chatear con el contenido del documento, hacer preguntas y obtener respuestas relevantes basadas en el contexto.
• Interfaz fácil de usar para garantizar una interacción perfecta.

Hacer

• [x] Mostrar documentos fuente para respuestas en la GUI web
• [x] Soporte de la transmisión de respuestas
• Soporte SWITH del tipo de cadena y la transmisión de la salida Langchain en la GUI web

Arquitectura

Instalación

Sugerir para instalar en Ubuntu en lugar de CentOS/Debian. Ver número #12

Para comenzar con Chat-with-your-doc , siga estos pasos:

1. Clon el repositorio:

git clone https://github.com/linjungz/chat-with-your-doc.git

2. Cambie en el chat-with-your-doc :

 cd chat-with-your-doc

3. Instale los paquetes de Python requeridos:

Crear entorno virtual:

python3 -m venv .venv
source .venv/bin/activate

Instalar Defenancías:

pip install -r requirements.txt

Configuración

En este proyecto, estamos apoyando tanto la API de OpenAI como el servicio de Azure Operai. Hay algunas variables ambientales que son comunes para las dos API, mientras que algunas son únicas. La siguiente tabla enumera todos los Vars Env que son compatibles:

Variables de entorno	Servicio Azure OpenAI	Opadai
OPERAI_API_BASE	✅
OPERAI_API_KEY	✅	✅
OPERAI_GPT_DEPLOYMENT_NAME	✅
OpenAI_embedding_Deployment_Name	✅	✅
Chat_model_name		✅
Request_timeout	✅	✅
Vectordb_path	✅	✅
TEMPERATURA	✅	✅
Chunk_size	✅	✅
Chunk_overlap	✅	✅

Servicios Azure OpenAI

1. Obtenga su clave Azure OpenAI API, punto final y nombre de implementación del portal de Azure.
2. Crear .env en la raíz Dir y establezca las variables de entorno en el archivo:

 OPENAI_API_BASE=https://your-endpoint.openai.azure.com
OPENAI_API_KEY=your-key-here
OPENAI_GPT_DEPLOYMENT_NAME=your-gpt-deployment-name
OPENAI_EMBEDDING_DEPLOYMENT_NAME=your-embedding-deployment-name

Aquí es donde puede encontrar los nombres de implementación para GPT e incrustación:

Opadai

1. Obtenga su tecla API OpenAI de la plataforma.openai.com.
2. Crear .env en el Dir Root y establezca la variable de entorno en el archivo:

 OPENAI_API_KEY=your-key-here
CHAT_MODEL_NAME="gpt-4-0314"

Uso: web

Esto inicializará la aplicación en función de Streamlit y abrirá la interfaz de usuario en su navegador web predeterminado. Ahora puede cargar un documento para crear una base de conocimiento y comenzar una conversación con él.

$ streamlit run chat_web_st.py --server.address ' 0.0.0.0 '

Collecting usage statistics. To deactivate, set browser.gatherUsageStats to False.


  You can now view your Streamlit app in your browser.

  URL: http://0.0.0.0:8501 ` ` `

Tenga en cuenta que la interfaz de usuario web anterior construida con Gradio está en desuso y ya no se mantiene. Puede encontrar el código en el archivo chat_web.py.

Uso: CLI

La aplicación CLI está creada para admitir comandos ingest y chat . Python Library typer se usa para construir la interfaz de línea de comandos.

Ingerir

Este comando tomaría los documentos como entrada, dividiría los textos, generaría los incrustaciones y almacenaría en una tienda FAISS . La tienda Vector se almacenaría localmente para más tarde para chat.

Por ejemplo, si desea poner todos los PDF en el directorio en una sola tienda vectorial llamada surface , podría ejecutar:

$ python chat_cli.py ingest --path " ./data/source_documents/*.pdf " --name surface

Tenga en cuenta que la ruta debe estar encerrada con cotizaciones dobles para evitar la expansión de la concha.

Charlar

Este comando comenzaría un chat interactivo, con documentos como una base de conocimiento externa en una tienda vectorial. Puede elegir qué base de conocimiento cargar para chat.

Se han proporcionado dos documentos de muestra sobre la superficie en el directorio Data/Source_Document y ya se ingirieron en el index de almacenamiento vectorial predeterminado, almacenado en Data/Vector_store. Puede ejecutar el siguiente comando para comenzar un chat con los documentos:

$ python chat_cli.py chat

O puede especificar la tienda Vector para cargar para el chat:

$ python chat_cli.py chat --name surface

Referencia

Langchain se aprovecha para construir rápidamente un flujo de trabajo que interactúa con Azure GPT-4. ConversationalRetrievalChain se usa en este caso de uso particular para apoyar el historial de chat. Puede consultar este enlace para obtener más detalles.

Para chaintype , se usan stuff por defecto. Para obtener más detalles, consulte este enlace

Créditos

• El uso de Langchain está inspirado en GPT4-PDF-Chatbot-Langchain
• La integración de Langchain Streaming and Stremlit está inspirada en ejemplos de simplificación
• El procesamiento de documentos está inspirado en OpenAientPriseChatBotandQa

Licencia

chat-with-your-doc ​​se lanza bajo la licencia MIT. Consulte el archivo LICENSE para obtener más detalles.