open source slack ai

O aplicativo AI de faixa aberta

Este repositório é uma solução básica de IA básica pronta a execução, você pode hospedar a si mesmo e desbloquear a capacidade de resumir threads e canais sob demanda usando o OpenAI (suporte para LLMs alternativos e de código aberto será adicionado se houver demanda). O produto oficial da Slack AI parece ótimo, mas com acesso limitado e preços complementares, decidi de código aberto a versão que construí em setembro de 2023. Saiba mais sobre como e por que eu construí uma IA de faixa aberta.

Uma vez em funcionamento (as instruções para todo o processo são fornecidas abaixo), todos os seus usuários do Slack poderão gerar para o público e privado:

1. Resumos de threads -Gere um resumo detalhado de qualquer tópico de folga (alimentado pelo GPT-3.5-Turbo)
2. Visão geral do canal - Gere um esboço do objetivo do canal com base no histórico de mensagens estendido (alimentado por um conjunto de modelos de PNL e um pouco GPT -4 para explicar a análise em linguagem natural)
3. Resumos do canal desde -Gere um resumo detalhado das mensagens de um canal, pois um determinado ponto no tempo (alimentado pelo GPT-3.5-turbo). Agora, com suporte para solicitações personalizadas! por exemplo /tldr_since anonymize the summary . Nota: Isso ainda não inclui threads.
4. Resumos completos do canal (experimental)-Gere um resumo detalhado do histórico estendido de um canal (alimentado pelo GPT-3.5-turbo). Agora, com suporte para solicitações personalizadas! por exemplo /tldr_extended anonymize the summary . Nota: Isso pode ficar muito longo!

Índice

• Começando
  • Pré -requisitos
  • Instalação
  • Uso
  • Personalização
• Teste
• Aprimoramentos futuros
• Contribuindo

Começando

Siga estas instruções para obter uma cópia do projeto em funcionamento em sua máquina local para fins de desenvolvimento e teste.

Pré -requisitos

Certifique -se de ter o seguinte pré -configurado ou instalado em sua máquina de desenvolvimento local:

• Python 3.9.x - 3.11.x
• Chave da API OpenAI
• Slack App e tokens de API associados
• Gerenciador de pacotes de poesia
• NGrok (recomendado)

Instalação

1. Clone o repositório da sua máquina local.
2. Navegue até o diretório do projeto.
3. Instale os pacotes Python necessários usando poesia:

poetry install

4. Instale o modelo de dicionário

poetry run python -m spacy download en_core_web_md

5. Crie um arquivo .env no diretório raiz do projeto e preencha -o com suas chaves e tokens da API. Use o arquivo example.env como modelo.

cp example.env .env && open .env

Configuração do aplicativo Slack

Faça uma cópia do manifest.json e altere o URL da solicitação para o seu NGROK ou URL do servidor.

Crie um novo aplicativo Slack aqui e configure -o usando seu arquivo manifest.yaml .

Você não precisa fazer outras alterações, mas pode alterar o nome, a descrição e outras configurações relacionadas à cópia.

Se você deseja ajustar o nome dos comandos Slash, precisará modificar slack_server.py .

Uma vez configurado, recupere a página "Usuário do BOT OAuth" da página "Instalar aplicativo" e adicione -a ao seu arquivo .env como SLACK_BOT_TOKEN .

Em seguida, na página de informações básicas sob o cabeçalho dos tokens no nível do aplicativo, crie um token com as connections:write e adicione-o ao seu arquivo .env como SLACK_APP_TOKEN .

Uso

Para executar o aplicativo, execute o servidor FASTAPI:

poetry run uvicorn ossai.slack_server:app --reload

Você precisará expor o servidor à Internet usando o NGROK.

Execute o NGrok com o seguinte comando: ngrok http 8000

Em seguida, adicione o URL NGROK às configurações do seu aplicativo Slack.

Personalização

As principais opções de personalização são:

• Resumo do canal: Personalize o prompt de chatgpt em topic_analysis.py
• Resumo do tópico: Personalize o prompt de chatgpt no summarizer.py

Teste

Este projeto usa pytest e pytest-cov para executar testes e medir a cobertura do teste.

Siga estas etapas para executar os testes com cobertura:

1. Navegue até o diretório raiz do projeto.

2. Execute o seguinte comando para executar os testes com cobertura:

   pytest --cov=ossai tests/

   Este comando executará todos os testes nos tests/ diretório e gerará um relatório de cobertura para o módulo ossai .

3. Depois de executar os testes, você verá um relatório no seu terminal que mostra a porcentagem de código coberto por testes e destaca todas as linhas que não sejam cobertas.

Observe que, se você estiver usando um ambiente virtual, verifique se ele está ativado antes de executar esses comandos.

Aprimoramentos futuros

• Mova -se para Langchain e Langsmith para extensibilidade, rastreamento e controle
• Aproveite os recursos de feedback de Langsmith para capturar e aprender com o feedback do usuário
• Adicione o comando A /tldr_since para resumir as mensagens de um canal desde uma determinada data
• Adicionar detalhes de configuração do aplicativo Slack e manifesto de aplicativo de amostra para ler
• Incorporar conversas encadeadas em resumos no nível do canal
• Implementar o EVALS Suite para complementar os testes de unidade
• Adicione suporte para LLMs alternativos e de código aberto
• Explore o fluxo de trabalho para coletar dados e modelos de ajuste fino para redução de custos
• Adicione suporte para resumos de mensagens anonimizados
• Aproveite ferramentas rápidas como a cadeia de destino
• Adicione suporte para puxar o contexto de apoio de fontes externas, como bases de conhecimento da empresa
• Explore o cache e outras otimizações de desempenho
• Explore a análise de sentimentos

Contribuindo

Eu mais do que bem -vindo contribuições! Leia CONTRIBUTING.md para obter detalhes sobre como enviar feedback, bugs, solicitações de recursos, aprimoramentos ou suas próprias solicitações de tração.

Licença

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