Introdução geral
O Kotaemon é uma ferramenta de perguntas e respostas de documentos de código aberto projetada para fornecer aos usuários finais e desenvolvedores a funcionalidade de perguntas e respostas baseada em RAG (Retrieval Augmented Generation). Desenvolvido pela Cinnamon, o projeto oferece suporte a vários provedores de API de LLM (por exemplo, OpenAI, AzureOpenAI, Cohere etc.), bem como a LLMs nativos. O Kotaemon oferece uma interface de usuário limpa e personalizável para perguntas sobre documentos e para a criação de RAG Tubulações.
Lista de funções
- Suporte para logins de vários usuários, organização de arquivos em coleções privadas/públicas
- Suporte para LLM nativo e provedores de API populares
- Fornecido com tubulação RAG mista para garantir uma qualidade de recuperação ideal
- Suporte multimodal de perguntas e respostas para documentos que contêm gráficos e tabelas
- Fornece scripts fáceis de instalar, sem necessidade de configuração de ambiente
Recursos funcionais
- Hospedagem da sua própria interface de usuário da Web do Documentation Quiz (RAG). Ofereça suporte a vários logins de usuários, organize arquivos por coleções privadas/públicas, colabore com outras pessoas e compartilhe seus bate-papos favoritos.
- Organize seu LLM e modelos de incorporação. Suporte para LLM nativo e provedores de API populares (OpenAI, Azure, Ollama, Groq).
- Tubos RAG mistos. Fornece um pipeline RAG padrão sensato combinado com um pesquisador híbrido (texto completo e vetor) + reordenação para garantir a qualidade ideal da pesquisa.
- Suporte multimodal a perguntas e respostas. Perguntas e respostas para vários documentos, com suporte para gráficos e tabelas. Suporte para análise de documentos multimodais (uma opção disponível na interface do usuário).
- Citações avançadas com visualização de documentos. O sistema fornece referências detalhadas por padrão para garantir que as respostas do LLM estejam corretas. Isso pode ser feito diretamente na seçãoVisualizador de PDFVisualizar citações (incluindo pontuações de relevância) e destacá-las. Avisar quando o pipeline de pesquisa retornar artigos de baixa relevância.
- Suporte para métodos de raciocínio complexos. Use a decomposição de perguntas para responder a perguntas complexas/multi-hop. Oferece suporte ao raciocínio baseado em agentes usando ReAct, ReWOO e outros agentes.
- Interface de usuário de configuração configurável. É possível ajustar a maioria dos aspectos importantes do processo de recuperação e geração (incluindo prompts) na interface do usuário.
- escalabilidade. Criado com base no Gradio, você pode personalizar/adicionar os elementos de interface do usuário que desejar. Além disso, nosso objetivo é oferecer suporte a várias estratégias de indexação e recuperação de documentos.
GraphRAGO pipeline de índice é fornecido como um exemplo.
Usando a Ajuda
Processo de instalação para usuários comuns
Download:através de (uma lacuna)Novos lançamentosdownloadkotaemon-app.zipDocumentação.
Instalação:
- Descompacte o arquivo baixado.
- entrar em
roteirose inicie o instalador que corresponde ao seu sistema operacional:- Windows.
run_windows.bat. Basta clicar duas vezes no arquivo. - macOS.
executar_macos.sh- Clique com o botão direito do mouse no arquivo e selecione "Abrir com outro aplicativo".
- Ative "Todos os aplicativos" e selecione "Terminal".
- Observação: Se quiser sempre abrir o arquivo usando o terminal, marque a caixa "Always open with this application" (Sempre abrir com este aplicativo).
- A partir de agora, clique duas vezes em seu arquivo e ele deverá funcionar perfeitamente.
- Linux.
run_linux.sh. Por favor, use obash run_linux.shExecute o script.
- Windows.
- Quando a instalação for concluída, o instalador perguntará se a interface do usuário do ktem foi iniciada; responda para continuar.
- Se o lançamento for bem-sucedido, o aplicativo será aberto automaticamente em seu navegador.
Processo de instalação do desenvolvedor
Implementação do Docker (recomendado)
docker run \ -e GRADIO_SERVER_NAME=0.0.0.0 \ -e GRADIO_SERVER_PORT=7860 \ -p 7860:7860 -it --rm \ taprosoft/kotaemon:v1.0
Vá para http://localhost:7860/ para acessar a interface da Web.
Implementação do código-fonte
Clone e instale os pacotes necessários em seu novo ambiente Python.
# opcional (configuração do ambiente) conda create -n kotaemon python=3.10 conda activate kotaemon # clonar este repositório git clone https://github.com/Cinnamon/kotaemon cd kotaemon pip install -e "libs/kotaemon[all]" pip install -e "libs/ktem"
Visualize e edite suas variáveis de ambiente (chaves de API, pontos de extremidade) na seção .env Médio.
(Opcional) Para ativar o visualizador PDF_JS em seu navegador, faça o download do arquivo PDF_JS_DIST e o extrai para o libs/ktem/ktem/assets/prebuilt
Iniciando o servidor Web
python app.py
O nome de usuário/senha padrão é: admin / admin. Você pode configurar outros usuários diretamente na interface do usuário.
Diretrizes para uso
- Login e gerenciamento de documentos::
- Os usuários podem acessar a plataforma por meio de um sistema de login multiusuário para organizar e gerenciar suas coleções de documentos.
- Suporta a categorização de arquivos em coleções privadas ou públicas para facilitar a colaboração e o compartilhamento.
- Função de perguntas e respostas::
- Os usuários podem fazer upload de documentos e realizar operações de Q&A na interface.
- Suporte a Q&A multimodal e capacidade de trabalhar com conteúdo de documentos que contenham gráficos e tabelas.
- Personalização do tubo RAG::
- Os desenvolvedores podem personalizar e visualizar o pipeline RAG usando a interface de usuário fornecida.
- Com suporte para LLM nativo e provedores de API populares, os usuários podem escolher o modelo certo de acordo com suas necessidades.
- Pesquisa híbrida::
- O sistema fornece um pipeline de pesquisa híbrido que combina pesquisas de texto completo e vetoriais para garantir a qualidade ideal da pesquisa.
- Suporte à função de reordenação para melhorar a relevância dos resultados da pesquisa.
- suporte multimodal::
- A plataforma suporta Q&A multimodal e é capaz de lidar com documentos que contêm gráficos e tabelas para uma experiência de Q&A mais abrangente.
Recursos avançados
- gerenciamento de modelos::
- Os usuários podem organizar e gerenciar seus próprios LLMs e modelos incorporados.
- Com suporte a modelos nativos e provedores de API populares, os usuários podem escolher o modelo certo de acordo com suas necessidades.
- Colaboração e compartilhamento::
- Os usuários podem compartilhar seus bate-papos favoritos com outras pessoas para facilitar a colaboração e a comunicação.
- O suporte a login multiusuário permite que os usuários colaborem e compartilhem na plataforma.
- Feedback e contribuições::
- O projeto está em desenvolvimento ativo e agradecemos o feedback dos usuários, os relatórios de problemas e os envios de RP.
