NL2SQL Tool

O NL2SQLTool foi projetado para converter linguagem natural em consultas SQL.

​

Visão Geral

Esta ferramenta é utilizada para converter linguagem natural em consultas SQL. Quando passada para o agente, ela irá gerar as consultas e, em seguida, utilizá-las para interagir com o banco de dados.

Isso possibilita múltiplos fluxos de trabalho, como por exemplo ter um Agente acessando o banco de dados para buscar informações com base em um objetivo e, então, usar essas informações para gerar uma resposta, relatório ou qualquer outro tipo de saída. Além disso, permite que o Agente atualize o banco de dados de acordo com seu objetivo.

Atenção: Por padrão, a ferramenta opera em modo somente leitura (apenas SELECT/SHOW/DESCRIBE/EXPLAIN). Operações de escrita exigem allow_dml=True ou a variável de ambiente CREWAI_NL2SQL_ALLOW_DML=true. Quando o acesso de escrita estiver habilitado, certifique-se de que o Agente use um usuário de banco de dados com privilégios mínimos ou um Read-Replica sempre que possível.

​

Modo Somente Leitura e Configuração de DML

O NL2SQLTool opera em modo somente leitura por padrão. Apenas os seguintes tipos de instrução são permitidos sem configuração adicional:

• SELECT
• SHOW
• DESCRIBE
• EXPLAIN

Qualquer tentativa de executar uma operação de escrita (INSERT, UPDATE, DELETE, DROP, CREATE, ALTER, TRUNCATE, etc.) resultará em erro, a menos que o DML seja habilitado explicitamente.

Consultas com múltiplas instruções contendo ponto e vírgula (ex.: SELECT 1; DROP TABLE users) também são bloqueadas no modo somente leitura para prevenir ataques de injeção.

​

Habilitando Operações de Escrita

Você pode habilitar DML (Linguagem de Manipulação de Dados) de duas formas:

Opção 1 — parâmetro do construtor:

from crewai_tools import NL2SQLTool

nl2sql = NL2SQLTool(
    db_uri="postgresql://example@localhost:5432/test_db",
    allow_dml=True,
)

Opção 2 — variável de ambiente:

CREWAI_NL2SQL_ALLOW_DML=true

from crewai_tools import NL2SQLTool

# DML habilitado via variável de ambiente
nl2sql = NL2SQLTool(db_uri="postgresql://example@localhost:5432/test_db")

​

Exemplos de Uso

Somente leitura (padrão) — seguro para análise e relatórios:

from crewai_tools import NL2SQLTool

# Apenas SELECT/SHOW/DESCRIBE/EXPLAIN são permitidos
nl2sql = NL2SQLTool(db_uri="postgresql://example@localhost:5432/test_db")

Com DML habilitado — necessário para workloads de escrita:

from crewai_tools import NL2SQLTool

# INSERT, UPDATE, DELETE, DROP, etc. são permitidos
nl2sql = NL2SQLTool(
    db_uri="postgresql://example@localhost:5432/test_db",
    allow_dml=True,
)

Habilitar DML concede ao agente a capacidade de modificar ou destruir dados. Ative apenas quando o seu caso de uso exigir explicitamente acesso de escrita e certifique-se de que as credenciais do banco de dados estejam limitadas aos privilégios mínimos necessários.

​

Requisitos

• SqlAlchemy
• Qualquer biblioteca compatível com o banco de dados (ex.: psycopg2, mysql-connector-python)

​

Instalação

Instale o pacote crewai_tools

pip install 'crewai[tools]'

​

Uso

Para utilizar o NL2SQLTool, você precisa passar a URI do banco de dados para a ferramenta. O formato da URI deve ser dialect+driver://username:password@host:port/database.

Code

from crewai_tools import NL2SQLTool

# psycopg2 foi instalado para rodar este exemplo com PostgreSQL
nl2sql = NL2SQLTool(db_uri="postgresql://example@localhost:5432/test_db")

@agent
def researcher(self) -> Agent:
    return Agent(
        config=self.agents_config["researcher"],
        allow_delegation=False,
        tools=[nl2sql]
    )

​

Exemplo

O objetivo principal da tarefa era:

“Recupere a receita mensal média, máxima e mínima para cada cidade, mas inclua apenas cidades que tenham mais de um usuário. Além disso, conte o número de usuários em cada cidade e classifique os resultados pela receita mensal média em ordem decrescente”

Assim, o Agente tentou obter informações do banco de dados; a primeira vez está errada, então o Agente tenta novamente, consegue a informação correta e repassa para o próximo agente.

O segundo objetivo da tarefa foi:

“Revise os dados e crie um relatório detalhado e, em seguida, crie a tabela no banco de dados com os campos baseados nos dados fornecidos. Inclua informações sobre a receita mensal média, máxima e mínima para cada cidade, mas apenas inclua cidades que possuam mais de um usuário. Também conte o número de usuários em cada cidade e classifique os resultados pela receita mensal média em ordem decrescente.”

Agora as coisas começam a ficar interessantes: o Agente gera a consulta SQL não só para criar a tabela, mas também inserir os dados na tabela. E, ao final, o Agente ainda retorna o relatório final que condiz exatamente com o que estava no banco de dados.

Este é um exemplo simples de como o NL2SQLTool pode ser utilizado para interagir com o banco de dados e gerar relatórios baseados nos dados do banco.

A ferramenta oferece possibilidades infinitas para a lógica do Agente e como ele pode interagir com o banco de dados.

 DB -> Agent -> ... -> Agent -> DB