Plug-in Dify com suporte a consultas a bancos de dados

Introdução geral

O dify-plugin-tools-dbquery é um Dify Um plug-in de código aberto projetado para a plataforma 1.0, lançado pelo desenvolvedor junjiem no GitHub. Ele fornece a funcionalidade de consulta ao banco de dados para ajudar os usuários a criar aplicativos baseados no Modelo de Linguagem Grande (LLM) para extrair dados do banco de dados e gerar conteúdo dinâmico em conjunto com o LLM. O plug-in contém duas ferramentas principais: Database Query Utils e Database Query Utils (Pre-authorisation), que são adequadas para cenários como questionários inteligentes e assistentes de análise de dados. O plug-in é compatível com a instalação via GitHub e oferece uma opção de empacotamento off-line, que é conveniente para os desenvolvedores implantarem em um ambiente sem rede.

Lista de funções

• Ferramenta de consulta de banco de dadosDados do banco de dados: recupere dados do banco de dados por meio de consulta SQL como entrada para o LLM.
• Suporte a consultas de pré-autorizaçãoFuncionalidade de consulta para autorizações pré-configuradas para simplificar o processo de acesso ao banco de dados.
• Integração da plataforma DifyIntegração perfeita de fluxos de trabalho e inteligências da Dify para aprimorar os recursos de processamento de dados do aplicativo.
• Suporte a pacotes de código aberto e off-lineO código-fonte e os pacotes de instalação off-line estão disponíveis para atender a uma ampla gama de necessidades de implementação.
• Geração de dados dinâmicosInsira os resultados da consulta no LLM para gerar respostas ou análises sensíveis ao contexto.

Usando a Ajuda

Processo de instalação

A instalação do dify-plugin-tools-dbquery precisa ser feita por meio dos repositórios do GitHub ou de pacotes off-line:

Método 1: Instalar via GitHub

1. Acesso aos repositórios do GitHub
   Abra seu navegador e digite https://github.com/junjiem/dify-plugin-tools-dbqueryacesse a página do projeto.
2. Vá para Gerenciamento de plug-ins da Dify
   Faça login na plataforma Dify, clique em "Plugins" no canto superior direito para acessar a página de gerenciamento de plugins, selecione "Install via GitHub".
3. Inserir informações do depósito
   Digite o endereço do repositório na página de instalação:https://github.com/junjiem/dify-plugin-tools-dbquerypara selecionar o número da versão e .difypkg (se você não o tiver, precisará empacotá-lo você mesmo, veja abaixo).
4. Solução de problemas de verificação de assinaturas
   Se você encontrar o erro "a verificação do plug-in foi ativada e o plug-in que você deseja instalar tem uma assinatura incorreta", será necessário modificar o .env Documentação:
   • localizar .env (geralmente no diretório de implantação do Dify).
   • Adicionar ou modificar:FORCE_VERIFYING_SIGNATURE=false.
   • Reinicie o serviço Dify:

     docker-compose restart
     

   • Tente fazer a instalação novamente.
5. Conclusão da instalação
   Clique em "Install" (Instalar) e aguarde até que a Dify faça o download e implemente o plug-in.

Método 2: Digite o pacote off-line e instale-o

Se precisar usá-lo sem um ambiente de rede, você pode empacotar o pacote off-line de acordo com as instruções oficiais:

1. Preparação do ambiente
   • Certifique-se de que o Docker, o Python e o pip estejam instalados.
   • download CLI do plug-in DifyEscolha a versão adequada ao seu sistema (por exemplo dify-plugin-linux-amd64).
2. armazém de clones

git clone https://github.com/junjiem/dify-plugin-tools-dbquery.git
cd dify-plugin-tools-dbquery/db_query

3. Baixar dependências
   Execute o seguinte comando para salvar a dependência localmente:

pip download -r requirements.txt -d ./wheels --index-url https://mirrors.aliyun.com/pypi/simple
sed -i '1i\--no-index --find-links=./wheels/' requirements.txt

4. Empacotamento de pacotes off-line
   Retorne ao catálogo principal e embale:

cd ..
dify-plugin-linux-amd64 plugin package ./db_query
mv db_query.difypkg db_query-linux-amd64.difypkg

gerado db_query-linux-amd64.difypkg Ou seja, é um pacote off-line.
5. Ajuste da configuração do Dify
Se o tamanho do plug-in exceder 50 MB (o limite padrão), você precisará modificar o parâmetro .env::

• PLUGIN_MAX_PACKAGE_SIZE=524288000(500 MB)
• NGINX_CLIENT_MAX_BODY_SIZE=500M
• Reinicie o serviço:

  docker-compose restart
  

6. Instalação do upload
   Na página de gerenciamento do plug-in da Dify, selecione "Upload Offline Packages" e escolha db_query-linux-amd64.difypkg para concluir a instalação.

Operação das principais funções

Após a conclusão da instalação, você poderá usar o plug-in seguindo as etapas abaixo:

1. configuração de consultas ao banco de dados

• Entre no Dify Studio
  No espaço de trabalho da plataforma Dify, abra o Studio e selecione um aplicativo (como o Chatflow ou o Workflow).
• Adicionar ferramenta de consulta
  No Workflow Editor, clique em "Add Tool" e selecione a ferramenta Database Query Utils talvez Database Query Utils (Pre-authorization).
• Definição dos parâmetros de consulta
• Para a ferramenta de consulta normal, digite uma instrução SQL como, por exemplo:

SELECT name, age FROM users WHERE age > 18

• Para ferramentas pré-autorizadas, insira um ID de consulta pré-configurado ou simplesmente use a consulta padrão.
• Configure a conexão do banco de dados (host, porta, nome de usuário, senha, etc.), por exemplo:

DB_HOST=localhost
DB_PORT=3306
DB_USER=root
DB_PASSWORD=yourpassword

• Clique em "Test" para confirmar se os dados retornados estão corretos.

2. resultado integrado do LLM

• Conexão de fluxos de trabalho
  Conecte a saída da ferramenta de consulta ao nó do LLM. Os resultados da consulta serão usados como entrada de contexto, por exemplo:
• Digite a pergunta: "Quais usuários têm mais de 18 anos?"
• Resultados da consulta:[{"name": "张三", "age": 25}, {"name": "李四", "age": 30}]
• LLM OUTPUT: "Zhang San (25 anos) e Li Si (30 anos) têm mais de 18 anos de idade."
• Tacos personalizados
  Defina a palavra de prompt no nó LLM:

根据以下数据回答问题：{{query_result}}

3. exemplos de aplicativos

• tomar:: Criação de um "assistente de classificação de desempenho".
• mover::

1. Crie um aplicativo Chatflow.
2. aumentar Database Query UtilsVerifique a tabela de guerra:

   SELECT player, score FROM leaderboard ORDER BY score DESC LIMIT 5
   

3. Conectar LLM, palavra-chave:

   列出前五名玩家的姓名和分数：{{query_result}}
   

4. Pergunta do usuário: "Quem são os cinco melhores?"
   Resultado: "Os cinco melhores jogadores são: Zhang San (100 pontos), Li Si (90 pontos), etc."

advertência

• segurançaAs ferramentas de pré-autorização precisam garantir que o escopo da autorização seja claro para evitar o vazamento de dados.
• otimização do desempenhoAo consultar grandes volumes de dados, adicione LIMIT ou indexação para aumentar a eficiência.
• Suporte à documentaçãoEm caso de dúvida, consulte os arquivos de exemplo do GitHub (por exemplo .yml) ou enviar um problema.

Com as etapas acima, os usuários podem começar a usar rapidamente o dify-plugin-tools-dbquery para obter uma combinação eficiente de consulta a banco de dados e LLM.