open source slack ai

La aplicación AI Slack AI de código abierto

Este repositorio es una solución de IA de holgura básica lista para ejecutar que puede alojarte y desbloquear la capacidad de resumir hilos y canales a pedido utilizando OpenAI (se agregará alternativo y se agregará LLM de código abierto si hay demanda). El producto oficial de Slack AI se ve muy bien, pero con acceso limitado y precios de complemento, decidí de código abierto la versión que construí en septiembre de 2023. Aprenda más sobre cómo y por qué construí una IA Slack de código abierto.

Una vez que está en funcionamiento (las instrucciones para todo el proceso se proporcionan a continuación), todos sus usuarios de Slack podrán generar tanto en público como privado:

1. Resúmenes de hilo : genere un resumen detallado de cualquier hilo flojo (alimentado por GPT-3.5-TURBO)
2. Descripción general del canal : genere un esquema del propósito del canal basado en el historial de mensajes extendidos (alimentado por un conjunto de modelos PNL y un pequeño GPT -4 para explicar el análisis en lenguaje natural)
3. Resúmenes de canales Desde : genere un resumen detallado de los mensajes de un canal desde un punto dado en el tiempo (alimentado por GPT-3.5-TURBO). ¡Ahora con soporte para indicaciones personalizadas! EG /tldr_since anonymize the summary . Nota: Esto aún no incluye hilos.
4. Resúmenes de canales completos (experimental): genere un resumen detallado de la historia extendida de un canal (alimentado por GPT-3.5-TURBO). ¡Ahora con soporte para indicaciones personalizadas! EG /tldr_extended anonymize the summary . Nota: ¡Esto puede ser muy largo!

Tabla de contenido

• Empezando
  • Requisitos previos
  • Instalación
  • Uso
  • Personalización
• Pruebas
• Mejoras futuras
• Que contribuye

Empezando

Siga estas instrucciones para obtener una copia del proyecto en funcionamiento en su máquina local para fines de desarrollo y prueba.

Requisitos previos

Asegúrese de tener el siguiente preconfigurado o instalado en su máquina de desarrollo local:

• Python 3.9.x - 3.11.x
• Clave de API de OpenAI
• Slack App & Associated API Tokens
• Administrador de paquetes de poesía
• ngrok (recomendado)

Instalación

1. Clonar el repositorio de su máquina local.
2. Navegue al directorio del proyecto.
3. Instale los paquetes de Python requeridos con poesía:

poetry install

4. Instale el modelo de diccionario

poetry run python -m spacy download en_core_web_md

5. Cree un archivo .env en el directorio raíz del proyecto y llénelo con sus claves y tokens API. Use el archivo example.env como plantilla.

cp example.env .env && open .env

Configuración de la aplicación Slack

Realice una copia de manifest.json y cambie la URL de solicitud a su URL NGROK o servidor.

Cree una nueva aplicación Slack aquí y configúrela utilizando su archivo manifest.yaml .

No debe necesitar hacer otros cambios, pero puede cambiar el nombre, la descripción y otras configuraciones relacionadas con la copia.

Si desea ajustar el nombre de los comandos de corte, deberá modificar slack_server.py .

Una vez configurado, recupere el "Token de usuario de BOT OAuth" de la página "Aplicación de instalación" y agréguelo a su archivo .env como SLACK_BOT_TOKEN .

Luego, en la página de información básica en el encabezado de tokens de nivel de aplicaciones, cree un token con las connections:write y agréguela a su archivo .env como SLACK_APP_TOKEN .

Uso

Para ejecutar la aplicación, ejecute el servidor FastAPI:

poetry run uvicorn ossai.slack_server:app --reload

Luego deberá exponer el servidor a Internet usando NGROK.

Ejecute ngrok con el siguiente comando: ngrok http 8000

Luego agregue la URL NGROK a la configuración de su aplicación Slack.

Personalización

Las principales opciones de personalización son:

• Resumen del canal: Personalice la solicitud de chatgpt en topic_analysis.py
• Resumen del hilo: Personalice el indicador de chatgpt en summarizer.py

Pruebas

Este proyecto utiliza pytest y pytest-cov para ejecutar pruebas y medir la cobertura de prueba.

Siga estos pasos para ejecutar las pruebas con cobertura:

1. Navegue al directorio de la raíz del proyecto.

2. Ejecute el siguiente comando para ejecutar las pruebas con cobertura:

   pytest --cov=ossai tests/

   Este comando ejecutará todas las pruebas en las tests/ directorio y generará un informe de cobertura para el módulo ossai .

3. Después de ejecutar las pruebas, verá un informe en su terminal que muestra el porcentaje de código cubierto por pruebas y resalta cualquier línea que no esté cubierta.

Tenga en cuenta que si está utilizando un entorno virtual, asegúrese de que esté activado antes de ejecutar estos comandos.

Mejoras futuras

• Muévase a Langchain y Langsmith para su extensibilidad, rastreo y control
• Aprovechar las capacidades de retroalimentación de Langsmith para capturar y aprender de los comentarios de los usuarios
• Agregue el comando A /tldr_since para resumir los mensajes de un canal desde una fecha determinada
• Agregar detalles de configuración de la aplicación Slack y manifiesto de la aplicación de muestra a ReadMe
• Incorporar conversaciones roscadas en resúmenes a nivel de canal
• Implementar la suite Evals para complementar las pruebas unitarias
• Agregar soporte para alternativos y LLM de código abierto
• Explore el flujo de trabajo para recopilar datos y modelos de ajuste fino para la reducción de costos
• Agregar soporte para resúmenes de mensajes anónimos
• Aproveche herramientas rápidas como Chain of Destiny
• Agregar soporte para extraer el contexto de apoyo de fuentes externas como las bases de conocimiento de la empresa
• Explore el almacenamiento en caché y otras optimizaciones de rendimiento
• Explore el análisis de sentimientos

Que contribuye

¡Más que bienvenido contribuciones! Lea CONTRIBUTING.md para obtener detalles sobre cómo enviar comentarios, errores, solicitudes de funciones, mejoras o sus propias solicitudes de extracción.

Licencia

Este proyecto tiene licencia bajo la licencia GPL -3.0; consulte el archivo LICENSE.md para más detalles.