deepread-contract 0.2.1

Biblioteca para validação de documentos e contratos brasileiros

DeepRead Contract 📄

Biblioteca Python para validação de documentos e contratos brasileiros.

Consulta dados de empresas na Receita Federal e valida:

• ✅ CNPJ (situação cadastral)
• ✅ Razão Social
• ✅ Endereços
• ✅ Poder de assinatura (QSA)

Instalação

pip install deepread-contract

Uso Rápido

Consultar CNPJ

from deepread_contract import consultar_cnpj, validar_cnpj

# Validar formato
if validar_cnpj("33.000.167/0001-01"):
    # Consultar na Receita Federal
    dados = consultar_cnpj("33.000.167/0001-01")
    
    print(dados["razao_social"])  # PETROLEO BRASILEIRO S A PETROBRAS
    print(dados["situacao"])       # ATIVA
    print(dados["socios"])         # Lista de sócios/administradores

Buscar Empresa por Nome

from deepread_contract import buscar_cnpj_por_nome

dados = buscar_cnpj_por_nome("Petrobras")
print(dados["cnpj"])  # 33.000.167/0001-01

Validar Documento

from deepread_contract import validar_documento_contrato

texto = """
CONTRATO DE PRESTAÇÃO DE SERVIÇOS
CONTRATANTE: Empresa XYZ, inscrita no CNPJ...
CLÁUSULA PRIMEIRA - OBJETO
"""

eh_contrato, qtd_keywords, keywords = validar_documento_contrato(texto)
print(f"É contrato: {eh_contrato}")  # True

Formatar CNPJ

from deepread_contract import formatar_cnpj, limpar_cnpj

formatar_cnpj("33000167000101")       # "33.000.167/0001-01"
limpar_cnpj("33.000.167/0001-01")     # "33000167000101"

Verificação de Contratos (com DeepRead)

OpenAI

from deepread_contract import ContractChecker

checker = ContractChecker(openai_api_key="sk-...")
resultado = checker.verificar("contrato.pdf")

print(resultado["resultado_final"])  # APROVADO, REPROVADO, PENDENTE
print(resultado["campos_aprovados"])
print(resultado["campos_reprovados"])

Azure OpenAI

from deepread_contract import ContractChecker

checker = ContractChecker(
    provider="azure",
    azure_api_key="sua-chave-azure",
    azure_endpoint="https://seu-recurso.openai.azure.com",
    azure_deployment="gpt-4o",
    azure_api_version="2024-02-15-preview"
)

resultado = checker.verificar("contrato.pdf")

Via Variáveis de Ambiente

# OpenAI
export OPENAI_API_KEY=sk-...

# Azure
export OPENAI_PROVIDER=azure
export AZURE_API_KEY=sua-chave-azure
export AZURE_API_ENDPOINT=https://seu-recurso.openai.azure.com
export AZURE_DEPLOYMENT_NAME=gpt-4o
export AZURE_API_VERSION=2024-02-15-preview

# Detecta automaticamente do ambiente
checker = ContractChecker()
print(checker.provider)  # "openai" ou "azure"

Autenticação

DeepReadAuth

from deepread_contract import DeepReadAuth

# OpenAI
auth = DeepReadAuth(openai_api_key="sk-...")

# Azure
auth = DeepReadAuth(
    provider="azure",
    azure_api_key="sua-chave",
    azure_endpoint="https://seu-recurso.openai.azure.com",
    azure_deployment="gpt-4o"
)

# Verificar configuração
print(auth.provider)        # "openai" ou "azure"
print(auth.has_api_key)     # True/False
print(auth.is_deepread_available)  # True/False

# Obter token
token = auth.get_token()

AuthenticatedClient

from deepread_contract import AuthenticatedClient

client = AuthenticatedClient(
    provider="azure",
    azure_api_key="...",
    azure_endpoint="...",
    azure_deployment="gpt-4o"
)

if client.is_ready:
    dr = client.get_deepread_client()
    resultado = dr.process("documento.pdf")

CLI

CLI machine-friendly para automação e uso por agentes de IA. Toda saída é JSON em stdout, erros em stderr, e o exit code reflete sucesso (0) ou falha (≥1).

Instalação

pip install deepread-contract[cli]

Comandos

Comando	Descrição
version	Mostra a versão instalada
cnpj <cnpj>	Consulta CNPJ na Receita Federal (BrasilAPI → ReceitaWS fallback)
buscar <nome>	Busca empresa por nome (Casa dos Dados)
classificar <documento>	Classificação rápida por keywords (sem IA)
verificar <documento>	Verificação completa do contrato (extração com IA + validação Receita)
keywords	Lista keywords de validação e exclusão
models	Lista modelos Pydantic disponíveis com seus campos

Exemplos

# Versão
deepread-contract version

# Consultar CNPJ
deepread-contract cnpj 33.000.167/0001-01

# Buscar empresa por nome (com filtro de UF opcional)
deepread-contract buscar "Petrobras" --uf RJ

# Classificação rápida (sem IA, só keywords)
deepread-contract classificar contrato.pdf

# Verificação completa do contrato
export OPENAI_API_KEY=sk-...
export DEEPREAD_API_TOKEN=dr_...
deepread-contract verificar contrato.pdf

Configurar Provider (OpenAI / Azure)

O comando verificar aceita as seguintes flags para configurar o LLM:

Flag	Env var	Descrição
--api-key	OPENAI_API_KEY	Chave do provider LLM
--token	DEEPREAD_API_TOKEN	Token do DeepRead
--model / -m	—	Modelo (default: gpt-4o)
--provider	—	Provider: openai (default) ou azure
--verbose / -v	—	Logs detalhados em stderr

# OpenAI (default)
deepread-contract verificar contrato.pdf \
  --api-key sk-... \
  --model gpt-4o

# Azure OpenAI
deepread-contract verificar contrato.pdf \
  --provider azure \
  --api-key <azure-key> \
  --model gpt-4o

Exit codes

Code	Significado
0	Sucesso (e contrato APROVADO no caso de verificar)
1	Falha genérica ou contrato REPROVADO/PENDENTE
2	Erro de configuração (chave/token ausente)
3	Arquivo não encontrado
4	Erro de execução (rede, API, etc.)

Estrutura de Resposta CNPJ

{
    "cnpj": "33.000.167/0001-01",
    "razao_social": "PETROLEO BRASILEIRO S A PETROBRAS",
    "nome_fantasia": "PETROBRAS",
    "situacao": "ATIVA",
    "data_abertura": "1966-09-28",
    "natureza_juridica": "Sociedade de Economia Mista",
    "capital_social": 205431960490.0,
    "endereco": {
        "logradouro": "AVENIDA REPUBLICA DO CHILE",
        "numero": "65",
        "bairro": "CENTRO",
        "cidade": "RIO DE JANEIRO",
        "uf": "RJ",
        "cep": "20031912"
    },
    "socios": [
        {"nome": "JOAO SILVA", "qualificacao": "Diretor"},
        ...
    ]
}

Estrutura de Resposta Verificação

{
    "resultado_final": "APROVADO",  # APROVADO, REPROVADO, PENDENTE
    "justificativa": "Todos os campos aprovados",
    "campos_aprovados": ["CNPJ - Empresa X", "Situação - Empresa X", ...],
    "campos_reprovados": [],
    "campos_pendentes": [],
    "empresas": [...],
    "assinaturas": [...],
    "metricas": {
        "tokens": 5000,
        "custo_usd": 0.025,
        "tempo_segundos": 12.5
    }
}

Exemplos

Veja a pasta examples/ para exemplos completos:

• exemplo_cnpj.py - Consulta de CNPJ
• exemplo_validacao_documento.py - Validação de documento
• exemplo_verificar_contrato.py - Verificação completa
• exemplo_cli.sh - Comandos CLI

Dependências

Obrigatórias

• requests - Requisições HTTP
• pydantic - Validação de dados

Opcionais

• openai - Para usar com OpenAI/Azure

Licença

MIT License - veja LICENSE para detalhes.

Contribuição

Contribuições são bem-vindas! Abra uma issue ou pull request.

---

Desenvolvido por BeMonkAI