SmartRead: Anote automaticamente documentos técnicos em PDF e forneça citações relevantes

Introdução geral

O SmartRead é uma ferramenta de código aberto baseada em IA projetada para documentos técnicos. Ele analisa automaticamente arquivos PDF e anota o conteúdo principal, como termos importantes, títulos ou ideias centrais, para ajudar os usuários a entender rapidamente documentos complexos. Ao mesmo tempo, ela também pode fornecer artigos e links de vídeo relacionados ao assunto do documento, para que o aprendizado seja mais abrangente. Esse projeto foi lançado pelo desenvolvedor Dev-Khant no GitHub, o código é totalmente público e de uso gratuito. O smartRead é adequado para técnicos, estudantes ou pesquisadores, sendo especialmente útil para pessoas que precisam ler PDFs técnicos com eficiência.

Lista de funções

• Adicione automaticamente anotações a PDFs técnicos para destacar o conteúdo principal, como termos, títulos ou passagens destacadas.
• Recomendar artigos e vídeos relevantes com base no conteúdo do documento para aumentar a profundidade do entendimento.
• Suporte para o processamento de uma ampla variedade de arquivos PDF técnicos, facilitando a leitura de documentos complexos.
• Permite o download de arquivos PDF anotados com todos os destaques e anotações preservados.
• O design de código aberto permite que os usuários visualizem o código, modifiquem os recursos ou enviem sugestões de melhoria.

Usando a Ajuda

O SmartRead é um projeto de código aberto hospedado no GitHub que os usuários precisam instalar e configurar para usar. Abaixo estão as etapas detalhadas para ajudá-lo a fazer o download e colocá-lo em funcionamento.

Processo de instalação

O SmartRead é executado em duas partes, front-end e back-end, e requer a preparação de um ambiente de desenvolvimento. Veja a seguir as etapas específicas de instalação:

Preparação do ambiente

1. Instalação de ferramentas básicas
   • Faça o download do Git (git-scm.) para clonagem de código.
   • Instale o Node.js (versão 18+.nodejs.org) para o front-end.
   • Instale o Python (versão 3.12.python.org) para desenvolvimento local de back-end.
   • Instalar o Docker (docker.com) para execuções em contêineres de back-end.
2. Código de download
   • Abra um terminal e execute-o:

     git clone https://github.com/Dev-Khant/smartread.git
     cd smartread
     

3. Configuração de variáveis de ambiente
   • Copie o arquivo de exemplo:

     cp backend/.env.example backend/.env
     cp web/.env.example web/.env.local
     

   • compilador backend/.envPreencha os dados a seguir (você precisa obter a chave por conta própria):

     PORT=8000
     HOST=0.0.0.0
     ENVIRONMENT=development
     MONGODB_URL=mongodb://seu endereço do MongoDB
     MISTRAL_API_KEY=sua chave Mistral
     GROQ_API_KEY=sua chave Groq.
     CLOUDINARY_CLOUD_NAME=seu nome Cloudinary
     CLOUDINARY_API_KEY=sua chave Cloudinary
     CLOUDINARY_API_SECRET=sua chave secreta do Cloudinary
     

   • compilador web/.env.local::

     NEXT_PUBLIC_BACKEND_API_URL=http://localhost:8000
     

Instalar e executar o front-end

1. Vá para o diretório do front-end:

cd web

2. Instale a dependência:

npm install

3. Inicie o front end:

npm run dev

4. Abra seu navegador e acesse http://localhost:3000Você pode ver a interface de front-end.

Instalar e executar o backend

• Uso do Docker (recomendado)

1. Vá para o diretório back-end:

cd backend

2. Construa a imagem espelhada:

docker build -t smartread-backend .

3. Execute o contêiner:

docker run -p 8000:8000 --env-file .env smartread-backend

• Desenvolvimento local (sem Docker)

1. Vá para o diretório back-end:

cd backend

2. Crie um ambiente virtual e ative-o:

python -m venv .venv
fonte .venv/bin/activate # Windows com .venv\Scripts\activate

3. Instale a dependência:

pip install -r requirements.txt

4. Inicie o back-end:

uvicorn main:app --reload --host 0.0.0.0 --port 8000

Como usar os principais recursos

Depois de instalado, a funcionalidade principal do SmartRead gira em torno do processamento de PDFs e das recomendações de recursos.

Função 1: Tecnologia de anotação automática em PDF

• procedimento

1. Prepare um arquivo técnico em PDF (por exemplo, um documento ou manual).
2. Carregamento de arquivos na interface de front-end (http://localhost:3000), ou no backend/input Pasta.
3. Clique em "Upload and Label" no front end ou execute-o no back end:

python main.py --file input/your filename.pdf

4. Quando o processamento estiver concluído, o PDF com anotações aparecerá no backend/output Pasta.

• Descrição funcional
  Uso do SmartRead IA Mistral responder cantando Groq O modelo analisa o documento, identifica o conteúdo principal e adiciona destaque ou anotação. Os resultados das anotações são exibidos no PDF para uma leitura rápida e fácil.

Função 2: Acesso a recursos relevantes

• procedimento

1. Depois de carregar o PDF na interface de front-end, marque a caixa "Get related resources" (Obter recursos relacionados).
2. ou executado no back-end:

python main.py --file input/your filename.pdf --resources

3. Quando o processamento é concluído, a interface ou o terminal exibe links para artigos e vídeos.

• Descrição funcional
  O sistema pesquisa na Web com base no conteúdo do PDF e recomenda artigos técnicos ou vídeos relevantes, com links armazenados no MongoDB e gerenciados pelo Cloudinary.

Função 3: Baixar o PDF com anotações

• procedimento

1. Clique em "Download" na interface de front-end ou acesse backend/output Pasta.
2. localizar Seu nome de arquivo_anotado.pdf, salve-o diretamente.

• Descrição funcional
  O PDF anotado mantém o texto original com novos destaques e anotações para facilitar o compartilhamento ou o arquivamento.

Operação da função em destaque

contribuição de código aberto

• procedimento

1. Modifique o código e faça o commit no GitHub:

git add .
git commit -m "Suas notas de alteração"
git push origin main

2. Crie uma solicitação pull no GitHub.

• Descrição funcional
  O SmartRead usa a licença MIT e incentiva os usuários a participarem do desenvolvimento para melhorar os modelos ou as interfaces de IA.

advertência

• Certifique-se de que as chaves do MongoDB, Mistral AI, Groq e Cloudinary estejam configuradas corretamente ou a funcionalidade será limitada.
• A versão atual é mais adequada para a documentação técnica em inglês; o suporte em chinês talvez precise ser otimizado.
• O Docker é mais estável e é recomendado que seja usado primeiro.

Com essas etapas, você pode usar o SmartRead Processing Technology PDF em sua totalidade. Fácil de usar, com resultados intuitivos, é perfeito para quem precisa de uma leitura aprofundada.

cenário do aplicativo

1. pesquisa acadêmica
   Enquanto os alunos trabalham em seus trabalhos, o SmartRead economiza tempo de pesquisa destacando os pontos principais e sugerindo recursos relevantes.
2. desenvolvimento de tecnologia
   Os programadores o utilizam para destacar parâmetros importantes durante a leitura da documentação da API e para acessar vídeos tutoriais.
3. Trabalho em equipe
   A equipe do projeto organiza manuais técnicos, que são rotulados de maneira uniforme e depois compartilhados para melhorar a eficiência da comunicação.

QA

1. O SmartRead é compatível com PDFs em chinês?
   Atualmente mais adequado para documentação técnica em inglês, o suporte em chinês está sendo otimizado.
2. Preciso fazer networking?
   Sim, é necessária uma conexão de rede para acessar recursos relevantes e executar modelos de IA.
3. Ele pode ser usado off-line?
   A função de rotulagem funciona off-line, mas as recomendações de recursos precisam estar on-line.