chat_with_your_docs

título	Emoji	colorfrom	Colorto	sdk	sdk_version	APP_FILE	preso	licença
Converse com seus documentos		azul	cinza	Gradio	4.41.0	app.py	falso	mit

Converse com seus documentos

Introdução

---

O aplicativo ChatWithyourDocs Chat é um aplicativo Python que permite conversar com vários formatos de documentos, como PDF, Páginas da Web e Vídeos do YouTube. Você pode fazer perguntas sobre os PDFs usando linguagem natural, e o aplicativo fornecerá respostas relevantes com base no conteúdo dos documentos. Este aplicativo utiliza um modelo de idioma para gerar respostas precisas para suas consultas. Observe que o aplicativo responderá apenas a perguntas relacionadas aos documentos carregados.

Como funciona

---

O aplicativo segue estas etapas para fornecer respostas às suas perguntas:

1. Carregamento do DOC: o aplicativo lê vários tipos de documentos e extrai seu conteúdo de texto.

2. Chunking de texto: O texto extraído é dividido em pedaços menores que podem ser processados ​​de maneira eficaz.

3. Modelo de idioma: o aplicativo utiliza um modelo de idioma para gerar representações vetoriais (incorporações) dos pedaços de texto.

4. Combinação de similaridade: quando você faz uma pergunta, o aplicativo a compara com os pedaços de texto e identifica os mais semanticamente semelhantes.

5. Geração de resposta: Os pedaços selecionados são passados ​​para o modelo de idioma, que gera uma resposta com base no conteúdo relevante dos documentos.

Dependências e instalação

---

Para instalar o bate -papo com seu aplicativo Docs, siga estas etapas:

1. Baixe a Biblioteca Ollama

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

2. Puxe os modelos de bate -papo que usaremos, neste caso usaremos LLAMA2, MISTRAL e GEMMA

    ollama pull llama2
   

    ollama pull mistral
   

    ollama pull gemma
   

3. Crie um novo ambiente com o Python 3.9 e ativá -lo, neste caso usaremos o CONA

    conda create -n cwd python=3.9
   

    conda activate cwd
   

4. Clone o repositório da sua máquina local.

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

    cd chat_with_your_docs
   

5. Instale as dependências necessárias executando o seguinte comando:

    pip install -r requirements.txt
   

6. Instale o FFMPEG para vídeos do YouTube:

    sudo apt-get install ffmpeg
   

Uso

---

Para usar o chat com seu aplicativo Docs, siga estas etapas:

1. Execute o arquivo main.py usando a CLI do streamlit. Execute o seguinte comando:

    python3 main.py
   

2. O aplicativo será iniciado no seu navegador padrão, exibindo a interface do usuário.

Arquitetura

Aulas:

• LLM: Esta classe abstrata serve como um plano para diferentes implementações de LLM. Possui subclasses como OllamaModel , OpenAIModel e HFModel que lidam com fornecedores específicos de LLM (Ollama, Openai e Abraçando o rosto).
• DOCs: Esta classe gerencia o carregamento de documentos de várias fontes, como PDFs, páginas da web e vídeos do YouTube.
• VectorStore: Esta classe cria uma representação vetorial dos documentos usando incorporações LLM para recuperação eficiente.
• Cadeia: Esta classe define o pipeline de processamento do chatbot. Pode ser uma cadeia simples para responder a perguntas básicas ou uma cadeia de recuperação que pesquise documentos com base no histórico de conversas.
• Chatbot: Esta classe lida com a interação do usuário, mantém o histórico de conversas e chama o método de cadeia apropriado para gerar respostas.
• ChatBotController: Esta classe é a principal interface para o usuário. Ele permite definir o modelo LLM, a fonte do documento e as opções de recuperação. Ele também lida com consultas do usuário e interage com a instância do chatbot.

Funcionalidade:

1. Configurando:

   • O usuário seleciona o provedor LLM (Ollama, Openai ou Huggingface) e o modelo de um menu suspenso. Opcionalmente, uma chave da API pode ser necessária para determinados fornecedores.
   • O usuário pode optar por adicionar documentos (PDF, URL da página da web ou URL de vídeo do YouTube) para tarefas de recuperação.

2. Processamento:

   • Com base no LLM e documentos escolhidos (se houver), o controlador configura a cadeia de processamento.
   • Uma cadeia simples é usada para responder a perguntas básicas sem recuperação de documentos.
   • Uma cadeia de recuperação envolve:
     • Criando uma representação vetorial dos documentos usando as incorporações do LLM.
     • Definindo solicitações para gerar consultas de pesquisa com base no histórico de conversas.
     • Recuperar documentos relevantes com base nas consultas geradas.
     • Usando os documentos recuperados para responder à pergunta do usuário.

3. Interação:

   • O usuário digita suas perguntas na interface de bate -papo.
   • O controlador chama o método predict do chatbot, passando a consulta e o histórico de conversas do usuário (se a recuperação estiver ativada).
   • O chatbot recupera a resposta apropriada com base na configuração da cadeia escolhida.

Recursos adicionais:

• A interface inclui botões para "desfazer" e histórico de conversas "claros".

No geral, este código demonstra uma arquitetura bem estruturada para um chatbot que pode aproveitar diferentes LLMs e incorporar a recuperação de documentos para recursos aprimorados.