Slack GPT

Slack GPT Bot

Este repositorio contiene un bot Slack GPT Bot basado en C#que utiliza el modelo GPT de Openai para responder las preguntas de los usuarios. La implementación se basa en la API Slack Sockets, lo que significa que no hay necesidad de alojar el bot en un servidor. El bot se puede ejecutar en cualquier máquina.

¿Te gustó esta herramienta? Haznos una visita :) https://prographers.com/

Características

• Integrar con el GPT-4 de OpenAI para responder preguntas
• Mantener el contexto de conversación en un formato roscado
• Integración del modo de enchufe con Slack
• Divide mensajes largos en múltiples mensajes y no rompe el formato de bloque de código
• Parámetros para controlar el comportamiento del bot
• Soporte de Docker
• Documentación completa
• Comandos personalizados predefinidos y dinámicos
• Contexto, un mensaje del sistema para todo el hilo -context

Dependencias

• .NET 8.0
• Opadai
• Flognet
• Slacknet.aspnetcore
• Octokit.net
• Newtonsoft.net
• Humanizador
• Litedb

Obtener la llave de API de OpenAI

1. Ir al tablero de OpenAI
2. Haga clic en el botón "Crear nueva tecla secreta".
3. Copie el secreto y póngalo en la variable OpenAIKey en appsettings.json .

Nota: El uso de la API de OpenAI requiere una cuenta pagada/de prueba. Puede encontrar más información sobre los precios aquí.

Configuración de permisos en Slack

Antes de que pueda ejecutar el bot Bot Slack GPT, debe configurar los permisos apropiados para su bot Slack. Siga estos pasos para configurar los permisos necesarios:

1. Crear aplicación Slack
2. Vaya a su tablero de API Slack y haga clic en la aplicación que creó para este bot.
3. En la barra lateral izquierda, haga clic en "OAuth & Permissions".
4. En la sección "Scopes", encontrará dos tipos de ámbitos: "Scopes de token Bot" y "ámbitos de token de usuario". Agregue los siguientes alcances en "Bot Token Scopes":
   • app_mentions:read : Permite que Bot lea los eventos de mención.
   • chat:write : permite que el bot envíe mensajes.
   • groups:history : permite que el BOT lea mensajes en canales privados.
   • channels:history : permite que BOT lea mensajes en canales públicos.
   • Tenga en cuenta que se requieren otros permisos dependiendo de la ubicación del bot.
5. Desplácese hasta el botón "OAuth Tokens para su espacio de trabajo" y haga clic en "Instalar la aplicación en el espacio de trabajo". Esto generará el SlackBotToken .
6. En la barra lateral izquierda, haga clic en "Modo de socket" y habilítelo. Se le pedirá que "genere un token de nivel de aplicación para habilitar el modo de socket". Genere un token llamado SlackAppToken y agregue las connections:write el alcance.
7. En la sección "Características afectadas" de la página "Modo de socket", haga clic en "Suscripciones de eventos" y alterne "Habilitar eventos" en "ON". Agregue el evento app_mention con la app_mentions:read el alcance en la sección "Suscríbete a los eventos BOT" debajo de la palanca.

Uso

1. Ejecutar el proyecto

dotnet run --project Slack-GPT-Socket

O vea #Docker para obtener más información sobre cómo alojarlo.

2. Invite el bot a su canal Slack deseado.
3. Mencione el bot en un mensaje y haga una pregunta. El bot responderá con una respuesta. Puede seguir mencionando el bot en el mismo hilo para continuar la conversación.

Puede iniciar su mensaje con el nombre del modelo sin parámetros, por ejemplo:

@GPT-4 Turbo ¿Cómo estás hoy?

Utilizará GPT-3.5-TURBO en lugar del modelo GPT-4 predeterminado. Ver GPTClient para obtener más alias.

Parámetros incorporados

Hay algunos parámetros incorporados. Use /gpt help para verlos. Puede modificar los parámetros en el archivo appsettings.json o por solicitud.

Consulte Gptdefaults.cs para obtener más información sobre los valores predeterminados o appsettings.Example.json .

Parámetros personalizados

Comandos predefinidos

Puede agregar sus propios parámetros personalizados al BOT para minimizar la escritura de cada solicitud repedida. Para hacerlo, agregue la definición de ITS a la sección GptCommands en appsettings.json . Por ejemplo:

 "GptCommands" : {
    "Commands" :  [
      {
        "Command" : " -refactor " ,
        "Description" : " Tells GPT to refactor provided code " ,
        "Prompt" : " Given the following code, refactor it to be more readable and maintainable. Please provide code documentation for all members in the code and comments where appropriate. "
      },
      {
      "Command" : " -prographers " ,
      "Description" : " A command to add infomation about Prographers " ,
      "Prompt" : " Prographers is software-house company that specializes in 3D product configurators. Prographers exists since 2016 and currently hires around 20 people. Prographers solutions focus on Web applications that are used by companies to configure their products. Applications produced are focusing on high-quality graphics and design, resulting in great products that customers awe. Prographers is located in Warsaw, Poland. "
      }
  }

uso:

@GPT -4 -Prógrafos ¿Qué sabes sobre los prógrafos?

@Gpt -4 -refactor public class Foo { public void Bar() { Console.WriteLine("Hello World"); } }

Comandos dinámicos

De manera similar, puede crear comandos dinámicos. Para hacerlo, llame a los /gpt commands add -command "prompt" "description" -global con el nombre del comando y el indicador.

• -command cómo se llamará a este comando. EG: -prographers
• -prompt el mensaje que se utilizará para este comando. EG: Prographers is software-house company...
• -description La descripción del comando. por ejemplo: A command to add infomation about Prographers esto es opcional.
• -global Flag hará que el comando esté disponible para todos los usuarios. De lo contrario, estará disponible para el usuario que lo creó.

/gpt commands help a ver más información sobre los comandos.

Estibador

Puede iniciar el contenedor Docker con el siguiente comando:

docker run -v ./appsettings.json:/app/appsettings.json --restart always ghcr.io/prographers/slack-gpt:latest

También puede usar el archivo docker-compose.yml para iniciar el contenedor, separado. Docker Compose extraerá automáticamente la imagen del registro de contenedores GitHub e iniciará el contenedor cuando eso suceda. Usará Watchtower para hacer eso.

docker-compose up -d

Recuerde poner el archivo appSettings.json en el mismo directorio que el comando para ambos casos.

Seguridad

Ambas imágenes no están expuestas en ningún puerto y no se puede acceder desde el exterior. La única forma de acceder al contenedor es a través de la API Slack. El contenedor también se está ejecutando como un usuario no raíz y no tiene acceso al sistema de host.

Limitaciones y consejos

• El Bot despojará su propia mención del mensaje, por lo que no se incluirá en el aviso. Esto es para evitar llamadas recursivas.
• El bot solo responderá a los mensajes que comienzan con su mención.
• Se ignoran las menciones en canales de propiedad de bot. (Podría cambiarse en el futuro.) Debe ser invitado al canal.
• Todos los comandos son insensibles a los casos.
• Bot solo construirá un hilo a partir de mensajes que comienzan con su mención y sus propios mensajes.
• Editar un mensaje activará una nueva respuesta como si se enviara un nuevo mensaje.
• Al editar un mensaje en el hilo, el bot responderá al mensaje editado. Ignorará cualquier hilo que se realizó después del mensaje editado.
• Eliminar un mensaje es una forma de volver a hacer el hilo. Entonces, es más fácil rastrear la conversación al editar el mensaje.
• Los mensajes efímeros generados por el bot desaparecerán después de las recargas de los clientes flojos. Puede deshabilitarlos en la configuración.

Ejecutar localmente desde la fuente

• Clonar el repositorio

git clone https://github.com/Prographers/Slack-GPT.git
cd Slack-GPT

• Restaurar paquetes Nuget

dotnet restore

Captura de pantalla

¡Mensajes de notificación!

---

Soporte de hilo!

---

¡Mensajes de error!