Legal_Expert_Contract_Advisor_Using_Precision_RAG

Perguntas e respostas de contrato

Visão geral

Este projeto tem como objetivo desenvolver um sistema de especialistas jurídicos de alta precisão para perguntas e respostas de contrato usando geração de recuperação upmentada (RAG). O sistema aproveita as técnicas avançadas de processamento de linguagem natural (PNL) para fornecer respostas precisas e com conhecimento de contexto a perguntas sobre contratos legais e integra um poderoso modelo de idioma com um mecanismo de recuperação personalizado para fornecer respostas precisas e contextualmente relevantes às consultas relacionadas ao contrato.

Índice

• Visão geral
• Estrutura do projeto
• Instalação
• Uso
• Desenvolvimento
• Avaliação
• Técnicas de otimização
• Contribuindo
• Licença
• Agradecimentos
• Contato

Características

• Pipeline de geração de recuperação de recuperação (RAG) para perguntas e respostas do contrato
• Retriever personalizável e componentes geradores
• Estrutura de avaliação usando métricas ragas
• Técnicas de otimização para melhor desempenho

Estrutura do projeto

 Legal_Expert_Contract_Advisor_Using_Precision_RAG/
├── data/
│   ├── raw/
│   ├── processed/
│   └── evaluation/
├── notebooks/
│   ├── 1_data_exploration.ipynb
│   ├── 2_rag_implementation.ipynb
│   └── 3_evaluation_and_optimization.ipynb
├── src/
│   ├── data/
│   │   ├── __init__.py
│   │   ├── preprocess.py
│   │   └── load_data.py
│   ├── models/
│   │   ├── __init__.py
│   │   ├── retriever.py
│   │   └── generator.py
│   ├── evaluation/
│   │   ├── __init__.py
│   │   └── metrics.py
│   └── utils/
│       ├── __init__.py
│       └── helpers.py
├── tests/
│   ├── test_data.py
│   ├── test_models.py
│   └── test_evaluation.py
├── config.yaml
├── requirements.txt
├── setup.py
├── main.py
├── .gitignore
└── README.md

• data/ : contém arquivos de dados crus e processados
• notebooks/ : Notebooks Jupyter para exploração, implementação e avaliação
• src/ : código -fonte para o sistema de pano
  • data/ : Carregamento de dados e scripts de pré -processamento
  • models/ : implementações de modelo de retriever e gerador
  • evaluation/ : Métricas e scripts de avaliação
  • utils/ : funções e utilitários auxiliares
• tests/ : Testes de unidade para vários componentes
• config.yaml : arquivo de configuração para configurações de projeto
• requirements.txt : Lista de dependências do projeto
• setup.py : script de configuração para o projeto
• main.py : ponto de entrada principal para executar o sistema de pano

Instalação

1. Clone o repositório

git clone https://github.com/dev-abuke/Legal_Expert_Contract_Advisor_Using_Precision_RAG.git

2. Navegue até o diretório do projeto

 cd Legal_Expert_Contract_Advisor_Using_Precision_RAG

3. Crie um ambiente virtual

python -m venv venv

4. Ative o ambiente

 source venv/bin/activate  # On Windows, use venvScriptsactivate

3. Instale as dependências necessárias:

pip install -r requirements.txt

Uso

1. Prepare seus dados de contrato e coloque -os no data/raw/ Diretório.

2. Pré -processo os dados

python src/data/preprocess.py

3. Execute o sistema de pano

python main.py

4. Avalie o desempenho do sistema:

python src/evaluation/evaluate.py

Desenvolvimento

• Use os notebooks Jupyter nos notebooks/ diretório para exploração e prototipagem.
• Implementar a funcionalidade principal no diretório src/ .
• Adicione testes de unidade nos tests/ diretório.
• Use config.yaml para gerenciar as configurações do projeto.

Avaliação

O desempenho do sistema é avaliado usando as seguintes métricas

• Precisão de recuperação e recordação
• Responder relevância
• Precisão factual
• Coerência de resposta

Consulte o caderno de avaliação para obter resultados e análises detalhados.

Técnicas de otimização

Este projeto explora várias técnicas de otimização, incluindo

1. Modelos de incorporação avançada para recuperação
2. Métodos de pesquisa híbrida
3. Expansão de consulta
4. Estratégias de Chunking
5. Engenharia rápida

Contribuindo

As contribuições para melhorar o sistema são bem -vindas. Siga estas etapas:

1. Fork o repositório
2. Crie uma nova filial ( git checkout -b feature/your-feature )
3. Faça suas alterações e cometê -las ( git commit -am 'Add new feature' )
4. Empurre para o ramo ( git push origin feature/your-feature )
5. Crie uma nova solicitação de tração

Licença

Este projeto está licenciado sob a licença do MIT - consulte o arquivo de licença para obter detalhes.

Agradecimentos

• 10 Academia para fornecer o desafio e oportunidade de aprendizado
• Lizzyai para a inspiração e orientação do projeto

Contato

Para qualquer dúvida, abra um problema neste repositório ou entre em contato com Abubeker Shamil.