younited genaibots

Projeto GenaiBots

Visão geral

GenaiBots é uma estrutura abrangente projetada para automatizar e gerenciar interações em diversas plataformas digitais. É principalmente uma ferramenta empresarial para integrar IA generativa em processos operacionais por meio de meios como mensagens instantâneas, e-mails, ferramentas de tickets ou ferramentas internas. Utilizando IA avançada e um sistema modular de plugins, permite a criação de fluxos operacionais sofisticados e modelos de interação adaptados para empresas e desenvolvedores.

Mais detalhes no wiki https://github.com/YounitedCredit/younited-genaibots/wiki Você também pode usar o chat com o GPT dedicado aqui para qualquer dúvida relacionada à instalação, configuração e desenvolvimento do GenaiBots: https://chatgpt. com/g/g-HGEDT9hA2-genaibots-assistant

este exemplo de webclient funciona bem com a estrutura se você quiser testá-lo rapidamente: https://github.com/Pilosite/genaibot-basicweb-client

Principais recursos

• Aprimoramentos de IA : integre IA generativa no centro das interações. Isso permite não apenas a geração personalizada de IA por meio de prompts, mas também a capacidade de acionar ações e gerenciar processos com um rápido ciclo de feedback.
• Manipuladores de ações personalizadas : crie facilmente ações personalizadas com base em gatilhos e condições específicas e invoque-as diretamente por meio de prompts.
• Arquitetura Extensível de Plugins : Expanda funcionalidades ou integre serviços de terceiros através de plugins, garantindo flexibilidade e extensibilidade.
• Integração com sistemas empresariais : Interface de IA generativa perfeitamente dentro da infraestrutura central de TI por meio de um servidor web ou contêiner Docker. Isso permite processar e rastrear tarefas executadas por bots em vários contextos (mensagens, ferramentas de tickets, e-mails, aplicativos personalizados).
• Serviços de back-end dinâmicos : integra-se a vários serviços de back-end para processamento e armazenamento de dados, permitindo que o sistema se adapte a casos de uso e requisitos específicos da empresa.

Requisitos do sistema

• Sistema operacional : Compatível com Windows, MacOS e Linux.
• Versão Python : 3.8 ou posterior.
• Bibliotecas e dependências adicionais : listadas no arquivo requirements.txt .

Guia de instalação

1. Clonar o repositório

   git clone https://github.com/YounitedCredit/younited-genaibots
   cd genaibots

2. Configurar ambiente virtual (recomendado)

   python -m venv venv
   source venv/bin/activate  # On Windows use `venvScriptsactivate`

3. Instalar dependências

   pip install -r requirements.txt

Configuração

Defina as configurações do aplicativo editando o arquivo config.yaml no diretório config . Certifique-se de que todas as chaves de API e configurações de banco de dados necessárias estejam definidas corretamente.

config.yaml

O arquivo config.yaml centraliza as definições de configuração do aplicativo GenaiBots. Aqui estão algumas seções principais e seus propósitos:

• BOT_CONFIG : Contém configurações relacionadas ao comportamento do bot e níveis de depuração.

  • LOG_DEBUG_LEVEL : Define o nível de depuração para registro.
  • PROMPTS_FOLDER , CORE_PROMPT , MAIN_PROMPT , SUBPROMPTS_FOLDER : Especifique os diretórios e arquivos para prompts.
  • SHOW_COST_IN_THREAD : alterne para mostrar informações de custo em threads.
  • Vários nomes e comportamentos padrão de plugins também são configurados aqui.

• UTILS : Contém configurações de utilitários, como configurações de log.

  • LOGGING : configura o registro em log, incluindo caminhos do sistema de arquivos e configurações do Azure.

• PLUGINS : Define os plugins disponíveis e suas configurações.

  • As categorias incluem ACTION_INTERACTIONS , BACKEND , USER_INTERACTIONS , GENAI_INTERACTIONS e USER_INTERACTIONS_BEHAVIORS .

Configuração do ambiente

As variáveis ​​de ambiente são carregadas via python-dotenv , normalmente de um arquivo .env . Isso permite que o aplicativo carregue dados confidenciais com segurança, como chaves de API e URLs de banco de dados. Aqui está uma visão geral básica de como funciona a configuração do ambiente no GenaiBots:

1. Carregando variáveis ​​de ambiente : a função load_dotenv() é chamada para carregar variáveis ​​de ambiente de um arquivo .env no aplicativo.
2. Acessando variáveis ​​de ambiente : as definições de configuração em config.yaml podem fazer referência a essas variáveis ​​de ambiente usando a sintaxe $(ENV_VAR_NAME) .

Executando o aplicativo

Execute o seguinte comando no diretório raiz do projeto:

python app.py

Isso iniciará o servidor e começará a lidar com solicitações com base em ações e gatilhos configurados.

Depuração no código do Visual Studio

Para depurar o aplicativo no Visual Studio Code, use o seguinte comando:

c: ; cd ' c:reposYuc.GenaiBots ' ; & ' C:Users<your profile>miniconda3python.exe ' ' c:Users<your profile>.vscodeextensionsms-python.debugpy-2024.6.0-win32-x64bundledlibsdebugpyadapter/../..debugpylauncher ' ' 64580 ' ' -- ' ' -m ' ' uvicorn ' ' app:app ' ' --host ' ' localhost ' ' --port ' ' 7071 ' ' --workers ' ' 1 ' 

Arquitetura de plug-ins

GenaiBots emprega uma arquitetura de plugin modular categorizada em várias famílias:

1. Interações de ação :

   • Plug-ins padrão : ações predefinidas para tarefas comuns.
   • Plug-ins personalizados : ações definidas pelo usuário adaptadas a necessidades específicas.

2. Back-end :

   • Lida com processamento interno de dados e interações com serviços de back-end.

3. Interações do usuário :

   • Mensagens instantâneas : plug-ins para lidar com plataformas de mensagens como Slack e Teams.
   • API personalizada : plug-ins para interagir com APIs personalizadas.

4. Interações GenAI :

   • Texto : Plugins para gerar e lidar com interações de texto usando IA.
   • Imagem : Plugins para gerar e manipular interações de imagens usando IA.
   • Pesquisa vetorial : plug-ins para lidar com funcionalidades de pesquisa vetorial.

5. Comportamentos de interação do usuário :

   • Define o comportamento das interações do usuário em diferentes plataformas de mensagens e APIs personalizadas.

Licença

Este projeto está licenciado sob a licença MIT - consulte o arquivo LICENSE.md para obter mais detalhes.

Suporte e Contato

Para qualquer dúvida de suporte ou para relatar problemas, visite nossa página de problemas do GitHub em: https://github.com/YounitedCredit/younited-genaibots/issues