Como realizar a configuração para utilizar a função de Chatbot no Fusion

Este manual fornece orientações para a configuração e uso do Chatbot de IA no Fusion, uma ferramenta que facilita a leitura e compreensão de arquivos na plataforma. Com o Chatbot de IA, é possível fazer perguntas sobre o conteúdo de um documento e receber respostas claras e objetivas, agilizando a busca por informações e auxiliando nas tarefas diárias. Essa funcionalidade adiciona uma camada de automação inteligente, tornando a comunicação e o fluxo de trabalho mais eficientes. Para mais detalhes sobre seu funcionamento e utilização, consulte nosso manual explicativo clicando aqui.

Nas próximas seções, você encontrará instruções detalhadas sobre como configurar o Chatbot no Fusion, garantindo que ele atenda suas necessidades e otimize o funcionamento da plataforma.

Chave de Acesso OpenAI

Para utilizar o Chatbot de IA no Fusion, é necessário ter uma chave secreta (secret key) da OpenAI.

Para acessar sua chave de API da OpenAI para uso com o Chatbot, acesse o site da OpenAI Clique aqui e faça login na sua conta da OpenAI. Se não tiver uma conta, será necessário criar uma.

Após o login, vá até o painel de controle na OpenAI e, no menu à esquerda, encontre a opção "API keys" ou "Chaves de API".

Por fim, basta gerar uma nova chave clicando na opção "Create new secret key" ou "Criar nova chave secreta".

Então, a chave será exibida em tela e será necessário copiar a chave e inserir ela no campo "Chave de acesso API Open AI" nas configurações de sistema do Fusion.

Atenção

Se não puder inserir a chave diretamente no Fusion, guarde-a em um local seguro, pois não é possível visualizá-la novamente após sair dessa página.

Nota

Para evitar restrições de uso, é recomendado que a conta da OpenAI tenha nível de acesso elevado para o tier 1 ou 2.

Instalando o Tesseract OCR

A instalação do Tesseract OCR é um passo essencial para otimizar a funcionalidade do Chatbot de IA. O Tesseract é uma poderosa ferramenta de reconhecimento óptico de caracteres (OCR) que permite converter imagens de texto em dados editáveis, facilitando a integração e análise de informações em diversos formatos. Ao integrar o Tesseract ao Chatbot de IA, garantimos que ele possa processar e compreender textos contidos em imagens ou documentos digitalizados, ampliando significativamente suas capacidades de interação e resposta.

Nesta seção, apresentaremos os passos necessários para a instalação do Tesseract, tanto em sistemas Linux quanto em Windows. Essa funcionalidade é especialmente importante em cenários onde a comunicação envolve documentos, formulários ou imagens que contêm informações relevantes. Com o Tesseract OCR, o Chatbot de IA se torna mais eficiente e capaz de atender às necessidades dos usuários de forma mais completa, proporcionando uma experiência mais fluida e eficaz.

Linux

Instalando o Pacote do Tesseract

Primeiro, selecione os pacotes conforme a distribuição do seu sistema operacional. O Tesseract possui pacotes de idiomas que permitem o reconhecimento em diferentes línguas, como português e inglês.

Para realizar a instalação do Tesseract em sistema operacional Linux, você pode realizar o seguinte comando caso ele seja instalado em distribuições baseadas em Debian (como o Ubuntu, por exemplo):

apt update
apt install tesseract-ocr tesseract-ocr-por tesseract-ocr-eng

Substitua tesseract-ocr-por e tesseract-ocr-eng pelos pacotes de idiomas específicos que desejar.

E o comando a seguir caso seja instalado em distribuições baseadas em RedHat (como o Fedora, por exemplo):

dnf install tesseract tesseract-langpack-por tesseract-langpack-eng

Assim como nas distribuições Debian, substitua tesseract-langpack-por e tesseract-langpack-eng pelos pacotes de idiomas adicionais conforme sua necessidade.

Após a instalação, você pode verificar se ela foi bem sucedida escrevendo o seguinte comando no terminal:

tesseract -v

Este comando deve retornar a versão do Tesseract instalada, confirmando que o software está pronto para uso.

Configurando a Variável de Ambiente TESSDATA_PREFIX

Para que o Tesseract possa localizar os arquivos de dados de idioma (como o português e inglês), é necessário configurar a variável de ambiente TESSDATA_PREFIX. Esta variável deve apontar para o diretório onde o Tesseract armazena seus arquivos de dados.

Para isso, abra o arquivo de inicialização do shell vigente (como .bashrc para Bash) no seu editor de texto preferido.

nano ~/.bashrc

Adicione uma linha para exportar a variável TESSDATA_PREFIX com o caminho do diretório de dados. Exemplos de caminhos comuns:

export TESSDATA_PREFIX=/usr/share/tesseract/tessdata

ou

export TESSDATA_PREFIX=/usr/share/tesseract-ocr/tessdata

Salve e feche o arquivo. Para aplicar a mudança imediatamente, recarregue o arquivo de configuração:

source ~/.bashrc

Para testar se o Tesseract está configurado corretamente, inicie um novo terminal e execute um comando OCR básico com uma imagem. Isso confirmará que o programa consegue acessar os dados de idioma configurados.

Windows

Instalando o Tesseract

Para realizar a configuração no Windows será necessário baixar o instalador do Tesseract. Para isso, acesse o repositório oficial do Tesseract OCR no GitHub clicando aqui.

Nessa URL, faça o download da versão mais recente do instalador para Windows.

Siga as instruções do instalador para concluir sua instalação. Durante a instalação, você poderá escolher os idiomas para os quais deseja suporte OCR.

Se você irá utilizar o Chatbot de IA para ler arquivos com imagens em português será necessário escolher o idioma Portuguese na opção Additional language data.

Ao aparecer o caminho em que a instalação será efetuada no computador, anote esse caminho, pois ele será necessário para configurar o Tesseract no sistema.

Configurando a Variável de Ambiente PATH

Para usar o Tesseract OCR diretamente pelo Prompt de Comando (cmd), é recomendável adicionar o diretório de instalação à variável de ambiente PATH. Isso permitirá que o sistema encontre o executável do Tesseract a partir de qualquer diretório.

Para isso, clique com o botão direito em Meu Computador ou Este Computador e selecione a opção Propriedades.

Em seguida, clique em Configurações avançadas do sistema.

Na aba Avançado, selecione Variáveis de Ambiente.

Na seção Variáveis do sistema, encontre a variável PATH e clique em Editar.

Por fim, clique em "Novo" para adicionar o caminho da pasta onde o Tesseract foi instalado e clique OK.

Criando a Variável TESSDATA_PREFIX

Ainda na janela de Variáveis de Ambiente, clique em Novo na seção Variáveis do sistema.

No campo Nome da variável, insira TESSDATA_PREFIX. No campo Valor da variável, insira o caminho completo da pasta tessdata dentro do diretório de instalação do Tesseract e clique em OK para salvar as alterações.

Após isso, pode ser necessário reiniciar o sistema para que as mudanças nas variáveis de ambiente sejam aplicadas.

Após reiniciar (caso necessário), verifique se a variável foi configurada corretamente. Para isso, abra o Prompt de Comando (cmd) e execute:

echo %TESSDATA_PREFIX%

Como resultado dessa consulta deve aparecer o caminho da pasta tessdata.

Testando a Instalação

Para verificar se o Tesseract foi instalado corretamente abra o Prompt de Comando (cmd) e digite o comando abaixo para verificar a versão instalada:

tesseract -v

Se o Tesseract estiver instalado corretamente, o sistema retornará a versão instalada.

Executando o Fusion Copilot

O Fusion Copilot é um serviço auxiliar do Fusion que deve ser executado no mesmo servidor onde o Fusion está em operação. Abaixo, seguem as orientações para uma execução padrão, ajustes de IP, e configuração como serviço do sistema.

Atenção

É necessário que o Fusion Copilot seja executado no mesmo servidor que o Fusion está sendo executado. Isso facilita a comunicação entre as duas plataformas, o que faz com que elas se comuniquem mais rapidamente através de protocolos locais, evitando problemas de rede ou firewall que poderiam interferir na comunicação.

Para casos em que o Fusion Copilot precise ser executado em um IP diferente, atribua o IP como primeiro argumento ao executável. Importante: Esse IP deve sempre apontar para o servidor do Fusion, já que o Copilot deve ser executado no mesmo servidor. Esse parâmetro serve para evitar problemas de BIND no IP padrão 0.0.0.0.

A sub-rede e as configurações de firewall devem permitir essa configuração, desde que as permissões adequadas estejam configuradas para a porta 8000, que é a porta padrão do Fusion Copilot.

Linux

Para executar o Fusion Copilot no Linux, siga os passos abaixo:

Crie uma pasta para armazenar o executável:

Para criar a pasta em /opt, execute no terminal:

sudo mkdir -p /opt/neomind/chatbot

Em seguida, altere o dono da pasta com:

sudo chown <usuário_do_serviço>:<grupo_do_serviço> /opt/neomind/chatbot

Importante: Substitua <usuário_do_serviço> e <grupo_do_serviço> pelo usuário e grupo que executam o serviço do Fusion Copilot. Isso garante que o serviço tenha as permissões corretas para acessar os arquivos.

Nota

Não mantenha o arquivo na pasta de Downloads, pois isso pode causar problemas de permissão ou impedir o correto funcionamento da leitura de arquivos.

Faça o download do executável com o seguinte comando:

wget https://nexus.neomind.com.br/nexus/repository/installers/fusion-ai/copilot/1.7/copilot-1.7-amd64.elf

Torne o arquivo executável e execute:

chmod +x copilot-1.7-amd64.elf
./copilot-1.7-amd64.elf

Windows

Para executar o Fusion Copilot no Windows, siga os passos abaixo:

Para armazenar o executável do Fusion Copilot, crie uma pasta chamada chatbot. O caminho para a pasta pode ser, por exemplo,C:\neomind\chatbot.

Nota

Evite manter o arquivo na pasta Downloads, pois isso pode causar problemas de permissão ou impedir o correto funcionamento da leitura de arquivos.

Faça o download do executável clicando aqui

Depois, execute o arquivo com um duplo clique para iniciar o Copilot.

Configuração do Fusion para o Copilot

No Fusion, é possível passar o argumento no Tomcat instalado para fazer a execução do Fusion, informando o IP e a porta 8000. Isso garante que o Fusion possa se conectar corretamente ao Fusion Copilot. Isto deve ser feito apenas se na configuração do Copilot for parametrizado um IP diferente do padrão 0.0.0.0

-Dfusion.chatbot-copilot.server.url=http://127.0.0.1:8000

Nota

Esse parâmetro pode ser passado nos parâmetros do Tomcatw em servidores Windows e setenv.sh em servidores Linux, porém, não é um parâmetro obrigatório quando o Copilot for executado na sua configuração de IP padrão. Caso seja necessário, deve ser informado conforme o exemplo apresentado acima.

Nesse caso, o Fusion já está pronto para aceitar qualquer aplicação do Chatbot instalado na porta 8000 em servidor local.

Caso o Chatbot seja instalado em outro IP esse parâmetro se torna obrigatório, para que sejam repassadas informações de IP e porta em que ele foi instalado.

No momento, não é possível alterar a porta padrão (8000) do Fusion Copilot. Caso você tenha outra aplicação rodando na porta indicada, será necessário alterar a porta da outra aplicação e deixar a porta 8000 livre para o Fusion Copilot.

Exemplos de Execução Bem-Sucedida

A seguir daremos alguns exemplos de execução bem-sucedida, para que seja possível mapear quando o Fusion Copilot está sendo executado ou não.

A seguir temos a execução bem sucedida quando o Fusion Copilot for instalado no mesmo servidor que o Fusion está sendo executado:

./copilot-1.7-amd64.elf
[2024-10-14 12:15:55 -0300] [277348] [INFO] Running on http://0.0.0.0:8000 
(CTRL + C to quit)

E um exemplo de execução bem sucedida quando for utilizado um servidor específico para a aplicação do Fusion Copilot:

./copilot-1.7-amd64.elf 127.0.0.1
[2024-10-14 12:19:44 -0300] [293645] [INFO] Running on http://127.0.0.1:8000
(CTRL + C to quit)

Nesse último caso, se a configuração da sub-rede ou as permissões de firewall não permitam o uso do IP especificado, uma mensagem de erro semelhante a esta será exibida:

OSError: [Errno 99] Cannot assign requested address

Configurando o Fusion Copilot como Serviço do Sistema

Para garantir que o Fusion Copilot inicie automaticamente com o sistema, é possível configurá-lo como um serviço do sistema.

• No Linux: Utilize o systemd para criar um serviço personalizado.
• No Windows: Use o "Agendador de Tarefas" para configurar uma tarefa que inicie o executável ao ligar o sistema.

Essa configuração é recomendada especialmente para ambientes onde o Fusion Copilot precisa estar sempre ativo e pronto para o uso. Dessa forma, o uso Copilot iniciará sempre junto com a máquina.

Linux

No Linux, o systemd é utilizado para gerenciar serviços do sistema. Você pode criar um arquivo de unidade (.service) que define como o Fusion Copilot será iniciado automaticamente no boot.

Para isso, abra um terminal e crie um novo arquivo de serviço para o Fusion Copilot em /etc/systemd/system/. Vamos chamá-lo de fusion-copilot.service:

nano /etc/systemd/system/fusion-copilot.service

Dentro do editor, adicione o seguinte conteúdo.

[Unit]
Description=Fusion Copilot Service
After=network.target

[Service]
ExecStart=CAMINHO_PARA_O_EXECUTAVEL
Restart=always
User=seu_usuario
Group=seu_grupo
Environment=TESSDATA_PREFIX=/usr/share/tesseract/tessdata

[Install]
WantedBy=multi-user.target

Note que será necessário refazer algumas configurações.

• Em CAMINHO_PARA_O_EXECUTAVEL coloque o caminho completo do executável do Fusion Copilot (por exemplo, /usr/local/bin/copilot-1.0-amd64.elf).
• Em User e Group substitua "seu_usuario" e "seu_grupo" pelo usuário e grupo que será utilizado para iniciar o Fusion Copilot. Esse usuário deve ser proprietário dos arquivos relativos ao Fusion Copilot baixados nesse guia.
• Em Environment insira o caminho da pasta tessdata que fica dentro do pacote do tesseract baixado no início desse guia.

Após inserir o conteúdo, salve e feche o arquivo. No nano, pressione CTRL + O para salvar e CTRL + X para sair.

Após configurar o arquivo, recarregue os arquivos de serviço do systemd para reconhecer o novo serviço:

systemctl daemon-reload

Em seguida, habilite o serviço para iniciar automaticamente com o sistema:

systemctl enable fusion-copilot.service

Agora, inicie o serviço manualmente para verificar se ele está funcionando:

systemctl start fusion-copilot.service

E para verificar se o serviço está rodando sem erros:

systemctl status fusion-copilot.service

Caso queira parar o serviço rode o comando a seguir:

systemctl stop fusion-copilot.service

Windows

No Windows, você pode usar o Agendador de Tarefas para criar uma tarefa que inicie o Fusion Copilot automaticamente ao ligar o sistema.

Para isso, pressione Win + S, digite Agendador de Tarefas, e selecione o aplicativo. No painel direito, clique em Criar Tarefa.

Na aba Geral, dê um nome à tarefa e na seção "Opções de segurança", selecione "Executar estando o usuário conectado ou não" e marque "Executar com privilégios mais altos" para garantir as permissões necessárias.

Na aba Disparadores clique em Novo.

E em "Iniciar a tarefa", selecione "Ao fazer logon" para que o Fusion Copilot inicie ao fazer login no sistema e clique em OK para salvar o disparador.

Na aba Ações, clique em Novo.

Em "Ação", selecione "Iniciar um programa" e em "Programa/script", insira o caminho completo do executável do Fusion Copilot. Clique em OK para salvar a ação.

Na aba Condições, você pode desmarcar a opção "Iniciar a tarefa somente se o computador estiver ligado na rede elétrica" para garantir que o serviço seja executado mesmo com o notebook desconectado da energia.

Em Configurações, certifique-se de marcar "Se ocorrer falha na tarefa, reiniciar a cada 15 minutos" para garantir que o Fusion Copilot seja reiniciado se algo der errado.

Clique em OK para salvar a tarefa. Com esses passos, o Fusion Copilot estará configurado para iniciar automaticamente com o sistema.