slack-smart-bot 1.14.1 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37c704bfddd83d7a7d34f9b15cea3cf8d1f01dde28c11c9e9bea01fb6ac9db19
-  data.tar.gz: 9785ce98b6695b77aaf89a0e239142e2443a4d812c2dcb1fe3119953f516d023
+  metadata.gz: 2c3c10ede28d806c5c386904621b877fdc1077f84f758b5affde34b3160340bf
+  data.tar.gz: 4db939606739e903c5d2916ea4d12409457eb3a62a8a740a0dec42f022f6bb70
 SHA512:
-  metadata.gz: 8e287b2173246c2adc1805738c87a6428ef43776213294558e1e900b29a03094df9b16d44b3a754d7b52d6a774a1a44da946cb553c4a5c9e83ca76b651239a1a
-  data.tar.gz: 9100ceee4ac4efd07a9ae4fae9d9014d00417626b0650bcd9bfa3824ff4070812cd9dfc79bbf26d68b088a43600ad22a469a40c137f4d9634066e9c2d133a596
+  metadata.gz: d204840c2f03710234fcc7f959b85256065cc312784cd5bb0f3e40aced01301a0a695c35e66161091d0b88e11d2e57283e47782752543240fff1ed00cda7ad0d
+  data.tar.gz: f06acd8003f313d2711710778e4a7119434d349107c4930e68800ef61620b367635ec047191061830711ee4c6eefbd5ade67eb06f320cdea2f249338cad22eb5

data/README.md

@@ -8,17 +8,18 @@
 ![GitHub last commit](https://img.shields.io/github/last-commit/MarioRuiz/slack-smart-bot)
 ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/MarioRuiz/slack-smart-bot)
 
-Create a Slack bot that is really smart and so easy to expand.
+Create a highly smart Slack bot that is incredibly easy to customize and expand.
 
-The main scope of this ruby gem is to be used internally in your company so teams can create team channels with their own bot to help them on their daily work, almost everything is suitable to be automated!!
+The primary purpose of this Ruby gem is to be used internally within your company, allowing teams to create dedicated channels with their own bot to assist them with their daily tasks. Almost any task can be automated with ease!
 
-slack-smart-bot can create bots on demand, create shortcuts, run ruby code... just on a chat channel, you can access it just from your mobile phone if you want and run those tests you forgot to run, get the results, restart a server... no limits.
+slack-smart-bot has the ability to create bots on demand, set up shortcuts, execute Ruby code, utilize ChatGPT, DALL-E, Whisper, and more. All of this can be done directly within a chat channel, even from your mobile phone. Whether you need to run forgotten tests, retrieve results, restart a server, summarize a channel or just a thread, or engage in a ChatGPT session, the possibilities are limitless.
 
-<img src="./img/smart-bot.png" width="150" height="150">![](./img/slack.png)
+<img src="img/smart-bot-150.png"><img src="img/slack-300.png"><img src="img/openai-300.png">  
 
 # Table of Contents
+(A): Only for Admins  
 
-- [Installation and configuration](#installation-and-configuration)
+- [Installation and configuration](#installation-and-configuration) (A)
 - [Usage](#usage)
   * [creating the MASTER BOT](#creating-the-master-bot) (A)
   * [How to access the Smart Bot](#how-to-access-the-smart-bot)
@@ -41,22 +42,24 @@ slack-smart-bot can create bots on demand, create shortcuts, run ruby code... ju
   * [Teams](#teams)
   * [Time off management](#time-off-management)
   * [OpenAI](#openai)
-    + [OpenAI Set up](#openai-setup)
+    + [OpenAI Set up](#openai-setup) (A)
     + [Chat GPT](#chatgpt)
     + [Image Generation](#image-generation)
     + [Image Variations](#image-variations)
     + [Image Editing](#image-editing)
     + [Whisper](#whisper)
     + [Models](#models)
+  * [Recap](#recap)
+  * [Summarize](#summarize)
+  * [Personal Settings](#personal-settings)
   * [Tips](#tips)
     + [Send a file](#send-a-file) (A)
     + [Download a file](#download-a-file) (A)
 - [Contributing](#contributing)
 - [License](#license)
 
-(A): Only for Admins
-
 ## Installation and configuration
+> for admins
 
     $ gem install slack-smart-bot
     
@@ -72,7 +75,9 @@ settings = {
     # the channel that will act like the master channel, main channel
     master_channel: 'my_master_channel',
     masters: ["mario"], #names of the master users
-    token: 'xxxxxxxxxxxxxxxxxx' # the API Slack token
+    token: 'xxxxxxxxxxxxxxxxxx', # the API Slack token
+    user_token: 'yyyyyyyyyy', # The API Slack User token
+    granular_token: 'zzzzzzzz' # The API Granular Slack Token
 }
 
 puts "Connecting #{settings.inspect}"
@@ -84,28 +89,87 @@ The master_channel will be the channel where you will be able to create other bo
 
 The masters will have full access to everything. You need to use the slack user name defined on https://YOUR_WORK_SPACE.slack.com/account/settings#username.
 
-For the token remember you need to generate a token on the Slack web for the bot user.
+Create the SmartBot *[Slack App. Bot Token](https://api.slack.com/slack-apps)* :
+
+  1) [Create a Classic Slack App](https://api.slack.com/apps?new_classic_app=1) This will be our *@smart-bot App* we will interact with. This App will use RTM to connect to Slack.    
 
-You can get one by any of these options:
+  1) Add a bot user to your app. On Add features and functionality section for your app, select *Bots*. Click on *Add a Legacy Bot User*
 
-- *[Slack App. Bot Token](https://api.slack.com/slack-apps)*. (Recommended)
+  1) On your app click on the menu on the left: *OAuth & Permissions*. Add the 'users.profile:write' scope. This is necessary for the SmartBot to be able to change the slack status of other users.  
+  
+  1) Now you will need to ask a workspace admin to click on *Install App to Workspace*.
 
-  1) [Create a Slack App](https://api.slack.com/apps?new_app=1)
+  1) Copy your *Bot User OAuth Access Token* and add it to the SmartBot settings with key :token
 
-  1) Add a bot user to your app. On Add features and functionality section for your app, select *Bots*. Click on *Add a Bot User*
+  1) Ask a workspace admin to provide the *User OAuth Token* and add it to the SmartBot settings with key :user_token  
 
-  1) On your app click on the menu on the left: *OAuth & Permissions* and click on *Install App to Workspace*.
+Now we will create the GranularSmartBot Slack App to get access to certain end points as a regular Slack App:  
 
-  1) Copy your *Bot User OAuth Access Token*.
+  1) [Create a Granular Slack App](https://api.slack.com/apps?new_app=1) This will be our @granular-smart-bot App. It will be used internally on the SmartBot. It is a regular Slack App with scopes.  
 
+  1) On your app click on the menu on the left: *OAuth & Permissions* and add on Bot Token Scopes the necessary Scopes: app_mentions:read, channels:history, channels:read, chat:write, chat:write.customize, emoji:read, files:read, groups:history, groups:read, im:history, im:read, im:write, incoming-webhook, mpim:history, mpim:read, mpim:write, reactions:read, reactions:write, team:read, users.profile:read, users:read, users:read.email  
+  
+  1) Click on *Install App to Workspace*.  
 
-- *[Legacy API Token](https://api.slack.com/custom-integrations/legacy-tokens)*. 
+  1) Copy the *Bot User OAuth Token* and add it to the SmartBot settings with the key :granular_token  
 
+Both Apps need to be on the channels we want to use the SmartBot.  
 
-*Remember to invite the smart bot to the channels where they will be accessible before creating the bot*  
+*Remember to invite the smart bot to the channels where they will be accessible before starting the bot*  
 
 SmartBot will notify about SmartBot status changes or any SmartBot incident if defined the status_channel in settings file and the channel exists. By default: smartbot-status  
 
+
+This is an example of typical settings to be supplied for the *Slack Smart Bot* instance:
+```ruby
+settings = {
+  token: ENV["SLACK_BOT_TOKEN"],
+  user_token: ENV['SLACK_USER_TOKEN'],
+  granular_token: ENV['SLACK_GRANULAR_BOT_TOKEN'],
+  masters: ["mario", "peterv", "lisawhite"], #master admin users
+  master_channel: "smartbot_master",
+  silent: true,
+  stats: true,
+  encrypt: true,
+  encryption: { # if not encryption key supplied then it will be generated one using the host name and the Slack token
+    key: ENV['ENCRYPTION_KEY'], 
+    iv: ENV['ENCRYPTION_IV']
+  },
+  github: {
+    token: ENV['GITHUB_TOKEN']
+  },
+  jira: {
+    host: ENV['JIRA_HOST'], 
+    user: ENV['JIRA_USER'], 
+    password: ENV['JIRA_PASSWORD']
+  },
+  public_holidays: {
+    api_key: ENV['CALENDARIFIC_API_KEY'],
+    default_calendar: 'spain/madrid'
+  },
+  ai: {
+    open_ai: {
+      access_token: ENV["OPENAI_ACCESS_TOKEN"],
+      chat_gpt: {
+        model: 'gpt-3.5-turbo-0613', # to be used by default for the user calling chatgpt command
+        smartbot_model: 'gpt-4-32k-0613' # to be used by default by the SmartBot internally
+      }
+    }
+  }
+}
+
+```
+
+You can see all the accepted settings on: [/lib/slack/smart-bot/config.rb](/lib/slack/smart-bot/config.rb)  
+
+To use the other integrated services:
+* OpenAI: https://platform.openai.com/account/api-keys
+* Calendarific: https://www.calendarific.com 
+* GitHub: https://github.com/settings/tokens
+* Jira: https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/
+
+
+
 ## Usage
 
 ### creating the MASTER BOT
@@ -233,7 +297,7 @@ To run a command on demand and add the response on a thread:
 
 Examples run a command on demand:  
 
-<img src="img/commands_on_demand.png" width="400">  
+<img src="img/commands_on_demand.png" width="500">  
 
 
 Also you can always call the Smart Bot from any channel, even from channels without a running Smart Bot. You can use the External Call on Demand: **_`@NAME_OF_BOT on #CHANNEL_NAME COMMAND`_**. In this case you will call the bot on #CHANNEL_NAME. You can supply more than one channel then all the bots will respond. In case you are in a private conversation with the Smart Bot (DM) then you can use directly:  **_`#CHANNEL_NAME COMMAND`_** or **_`on #CHANNEL_NAME COMMAND`_**
@@ -243,13 +307,13 @@ Examples:
 <img src="img/commands_on_external_call.png" width="400">  
 
 Examples on DM:
->**_Peter>_** `#sales show report from India`
+>**_Peter>_** `#sales show report from India`  
 >**_Peter>_** `on #sales notify clients`
 
 If you want the Smart Bot just listen to part of the message you send, add the commands you want using '`' and start the line with '-!', '-!!' or '-^'
 
 Examples:  
-<img src="img/commands_inline.png" width="400">  
+<img src="img/commands_inline.png" width="500">  
 
 
 All the commands specified on `./rules/general_commands.rb` will be accessible from any channel where the Smart Bot is present, without the necessity to call it with !, !!, ^ or on demand.
@@ -270,7 +334,7 @@ To show only the specific rules of the Smart Bot defined on the rules file: **_`
 Also you can call `suggest command` or `random command` and SmartBot will return the help content for a random command.
 
 Example:  
-<img src="img/command_bot_help_echo.png" width="300">  
+<img src="img/command_bot_help_echo.png" width="250">  
 
 
 When you call a command that is not recognized, you will get suggestions from the Smart Bot.
@@ -292,7 +356,7 @@ For the examples use _ and for the rules `. This is a good example of a Help sup
 # help:     _execute smoke tests on db1_
 ```
 
-To see what's new just call `What's new`
+To see what's new just call `What's new`. And to get the SmartBot README call `get smartbot readme`.  
 
 ### Bot Management
 > for admins
@@ -350,7 +414,7 @@ Also you can always call the Smart Bot from any channel, even from channels with
 You can run Ruby code by using the command: **_`ruby THE_CODE`_**. 
 
 Example:  
-<img src="img/command_ruby.png" width="500">  
+<img src="img/command_ruby.png" width="650">  
 
 
 Also it is possible to attach a Ruby file and the Smart Bot will run and post the output. You need to select Ruby as file format. Or if you prefer it you can call the `ruby` command and on the same message supply a code block.
@@ -358,6 +422,9 @@ Also it is possible to attach a Ruby file and the Smart Bot will run and post th
 #### REPL
 > for all users
 
+For a quick introduction play this video:  
+[![SmartBot REPLs](https://img.youtube.com/vi/URMI3BdD7J8/0.jpg)](https://www.youtube.com/watch?v=URMI3BdD7J8)  
+
 Easily starts a REPL session so you will be able to create a script directly from the slack conversation. You will be able to share the REPL so they can run it or see the content.
 
 It Will run all we write as a ruby command and will keep the session values until we finish the session sending `quit`, `exit` or `bye` 
@@ -377,6 +444,8 @@ To pre-execute some ruby when starting the session add the code to `.smart-bot-r
 
 If you want to see the methods of a class or module you created use `ls TheModuleOrClass`. To see all documentation of a method: `doc TheModuleOrClass.method_name`. And to see the source code of a method: `code TheModuleOrClass.method_name`. Examples: `ls Sales`, `doc Sales.list`, `code Sales.list`  
 
+During the REPL session you can ask *ChatGPT* about the code or any other question. Just start the message with `?` and the Smart Bot will ask ChatGPT and will post the answer. Example: `? How to create a new customer?`. If you send just the question mark without a prompt then ChatGPT will suggest next code line. Example: `?`  
+
 You can supply the Environmental Variables you need for the Session  
 
 Examples:  
@@ -388,9 +457,9 @@ Examples:
 
 
 Running Example:  
-<img src="img/command_repl1.png" width="600">  
+<img src="img/command_repl1.png" width="650">  
 
-<img src="img/command_repl2.png" width="600">  
+<img src="img/command_repl2.png" width="650">  
 
 
 Runnning on demand the repl we created:  
@@ -428,7 +497,7 @@ That shortcut will be available for you, in case you want to make it available f
 
 Example:  
 
-<img src="img/command_add_sc.png" width="500">  
+<img src="img/command_add_sc.png" width="650">  
 
 
 In case you want to use a shortcut as a inline shortcut inside a command you can do it by adding a $:
@@ -460,7 +529,7 @@ Examples:
 
 To see the announcements of the channel: **_`see announcements`_**, **_`see COLOR announcements`_**, **_`see EMOJI announcements`_** and to delete a particular announcement: **_`delete announcement ID`_**  
 
-<img src="img/command_see_announcements.png" width="500">  
+<img src="img/command_see_announcements.png" width="650">  
 
 If you are a master admin and you are on master channel then you can call **_`publish announcements`_** that will publish the announcements on all channels. The messages stored on a DM won't be published. This is very convenient to be called from a *Routine* for example every weekday at 09:00.
 
@@ -540,7 +609,7 @@ Examples:
 >**_`quit loop 1`_**  
 >**_`stop iterator 12`_**  
 
-<img src="img/command_loop.png" width="400">  
+<img src="img/command_loop.png" width="500">  
 
 ### Control who has access to a command
 > for admins
@@ -574,7 +643,7 @@ If you want to change who has access to a specific command without restarting th
         # helpadmin:      
       when /\A\s*update\s+access\s*\z/i
         save_stats(:update_access)
-        if is_admin?(user.name)
+        if is_admin?()
           config.allow_access.repl = ['marioruiz', 'samcooke']
           respond "updated on <##{@channel_id}>!"
         else
@@ -589,7 +658,7 @@ if has_access?(:your_command_id)
 end
 ```
 
-Also you can allow or deny access for specific commands and users on any specific channel all you need is the Smartbot to be a member of the channel and use these commands on Slack:
+Also you can allow or deny access for specific commands and users on any specific channel all you need is the Smartbot to be a member of the channel and use these commands on Slack:  
 `allow access COMMAND_ID`  
 `allow access COMMAND_ID @user1 @user99`  
 It will allow the specified command to be used on the channel.  
@@ -617,7 +686,10 @@ Examples:
 >**_`most used commands`_**  
 
 ### Teams
-> for all users
+> for all users  
+
+For a quick introduction play this video:  
+[![SmartBot Teams](https://img.youtube.com/vi/u8B4aGDXH9M/0.jpg)](https://www.youtube.com/watch?v=u8B4aGDXH9M)  
 
 You can add, update, see, ping and delete teams. When calling `see TEAM_NAME team` the availability of the members will be displayed.  
 `add team TEAM_NAME PROPERTIES` will add a team with the info supplied. In case it is supplied a channel with type 'members' the members of that channel would be considered members of the team.  
@@ -676,7 +748,7 @@ Examples:
 >**_`sales team memo 4 Put it on hold until tests for Apple feature are finished`_**  
 >**_`sales team memo 7`_**  
 
-<img src="img/command_see_team.png" width="600">  
+<img src="img/command_see_team.png" width="650">  
 
 
 Other team commands: **_`delete team TEAM_NAME`_**, **_`delete memo ID from team TEAM_NAME`_**, **_`set STATUS on memo ID TEAM_NAME team`_**, **_`see MEMO_TYPE from TEAM_NAME team TOPIC`_**  
@@ -691,11 +763,10 @@ The vacation plan will be displayed also with the team when calling `see team NA
 
 Also, you can see the vacation plan for the team for a specific period: `vacations team NAME YYYY/MM/DD`  
 
-To be able to use this command you need to allow the 'users.profile:write' scope on your Slack App and an admin user of the workspace needs to install the app. Set the user token on the SmartBot settings:  
+To be able to use this command you need to allow the 'users.profile:write' scope on your Slack App and an admin user of the workspace needs to install the app. Set the user token provided by the workspace on the SmartBot settings:  
 
 ```ruby
 settings = {
-  token: ENV["SLACK_BOT_TOKEN"],
   user_token: ENV['SLACK_USER_TOKEN']
 }
 ```
@@ -706,43 +777,70 @@ Add to your Smartbot configuration:
 ```ruby
 settings = {
   public_holidays: { 
-      api_key: API_KEY
+      api_key: ENV['CALENDARIFIC_API_KEY']
   }
 }
 ```
 
 When calling `see my time off` on a DM will display a calendar of the year with the days off, including public holidays  
 
-<img src="img/command_my_timeoff.png" width="650">
+<img src="img/command_my_timeoff.png" width="750">
 
 Other 'time off' commands: **_`remove time off ID`_**, **_`see my time off`_**, **_`see vacations @USER`_**, **_`time off team NAME`_**, **_`set public holidays to COUNTRY/REGION`_**    
 
 
 ### OpenAI
-> for all users  
+
 #### OpenAI setup
-To be able to use this SmartBot general command you need to ask for an API token: https://platform.openai.com/account/api-keys  
+> for admins  
+
+To be able to use this SmartBot general command you need to ask for an API token: https://platform.openai.com/account/api-keys or supply a Host and api_key for Azure OpenAI.    
 
 Then specify in the SmartBot config the keys:  
 
 ```ruby
 ai: {
+  # for all open_ai services
   open_ai: {
-               access_token: 'OPENAI_ACCESS_TOKEN',
-              organization_id: 'OPENAI_ORGANIZATION_ID',
-              gpt_model: 'gpt-3.5-turbo',
-              whisper_model : 'whisper-1',
-              image_size: '256x256'
+      #default host and token for all openAI services
+      host: 'HOST', # optional
+      access_token: 'OPENAI_ACCESS_TOKEN',
+      # Optional. For chatGPT. If supplied it will be used instead of the ones defined for all open_ai services
+      chat_gpt: { 
+        host: 'HOST',
+        access_token: 'OPENAI_ACCESS_TOKEN', #or OPENAI_API_KEY from Azure
+        api_type: :openai_azure, #Default type will be :openai (possible values are :openai, :openai_azure) 
+                             #If supplied :openai_azure then it is necessary to supply host
+        api_version: '2023-03-15-preview', # Default api version for :openai_azure
+        model: 'gpt-3.5-turbo',
+        smartbot_model: 'gpt-3.5-turbo'
+      },
+      # Optional. For DALL-E. If supplied it will be used instead of the ones defined for all open_ai services
+      dall_e: {
+        host: 'HOST',
+        access_token: 'OPENAI_ACCESS_TOKEN',
+        image_size: '256x256',
+      },
+      # Optional. For Whisper. If supplied it will be used instead of the ones defined for all open_ai services
+      whisper: {
+        host: 'HOST',
+        access_token: 'OPENAI_ACCESS_TOKEN',
+        model: 'whisper-1',
+      }
   }
 }
 ```
 
 Or if you want you can set your personal access token just to be used by you by calling on a DM with the SmartBot the command: `set personal settings ai.open_ai.access_token ACCESS_TOKEN`  
-Also you can specify personal settings for `gpt_model`, `whisper_model` or `image_size`, instead of using the default values.  
+Also, you can specify personal settings for `host`, `ai.open_ai.chat_gpt.model`, `ai.open_ai.chat_gpt.smartbot_model`, `ai.open_ai.whisper.model` or `ai.open_ai.dall_e.image_size`, instead of using the default values.  
+For using different hosts or tokens for each service you can use the `chat_gpt`, `dall_e` or `whisper` keys.  
 
 #### ChatGPT
+> for all users  
+
+For a quick introduction play this video:  
+[![SmartBot ChatGPT](https://img.youtube.com/vi/zri_R6sLtBA/0.jpg)](https://www.youtube.com/watch?v=zri_R6sLtBA)  
 
-`??`  
 `?? PROMPT`  
 `? PROMPT`  
 Chat GPT will generate a response based on the PROMPT indicated.  
@@ -751,9 +849,37 @@ You can share a message and use it as input for the supplied prompt.
 
 <img src="img/chat_gpt.png" width="650">  
 
-<img src="img/chat_gpt_share.png" width="300">  
+<img src="img/chat_gpt_share.png" width="600">  
+
+
+When using ?? a temporary chatGPT session will be created. If you want to start a session with a given name use `chatGPT SESSION_NAME`. You can add also the description of the session by using `chatGPT SESSION_NAME "DESCRIPTION"`.  
+If you want to categorize your sessions you can use `chatGPT SESSION_NAME >TAG_NAME`.  
+You can supply also a specific GPT model to be used. `chatGPT SESSION_NAME MODEL_NAME`.  
+To get all prompts from a specific session name use `chatGPT get SESSION_NAME`.  
+To list all sessions you created use `chatGPT sessions`.  
+When starting a new session, if you ask SmartBot to answer on a Thread by using !! or ^, then it won't be necessary to send ? before the prompt. In this case, every single message you send will be considered a prompt to be treated. After 30 minutes of inactivity, SmartBot will stop listening to the thread. You will need to continue the session after that. If you want to avoid a message to be treated then start it with a hyphen '-'.  
+To add a collaborator when on a thread, you can use directly `add collaborator @USER`  
+If you include in the prompt `!URL` then it will download and use the content of the URL as input for the prompt.  
+When on a thread you can change the model to be used by sending `use model MODEL_NAME`. For a temporary session if you want to create the session with a specific model use `?? use model MODEL_NAME`. The model supplied can be a substring of the model name, SmartBot will try to find the model that matches the substring.    
+
+<img src="img/chat_gpt_session.png" width="650">  
+
+You can copy your session by using `chatGPT copy SESSION_NAME NEW_SESSION_NAME`.  
+To share your session with everyone use `chatGPT share SESSION_NAME`. Then the session will be available for everyone to use. If you prefer to share it with a specific channel use `chatGPT share SESSION_NAME #CHANNEL`. In that case, only the users on that channel will be able to use the session.  
+To list all public sessions call `chatGPT public sessions`. To list all shared sessions in a channel, from that channel call `chatGPT shared sessions`. You can also filter the sessions by tag, for example, `chatGPT public sessions >TAG_NAME`.  
+If you want to use any public or shared session, you can use `chatGPT use USER_NAME SESSION_NAME` or `chatGPT use USER_NAME SESSION_NAME NEW_SESSION_NAME`.  
+To remove any shared session from the list, call `chatGPT stop sharing SESSION_NAME` or `chatGPT stop sharing SESSION_NAME #CHANNEL`.  
+
+Play this video:  
+[![SmartBot ChatGPT Share Sessions](https://img.youtube.com/vi/Mnve3tnEd-8/0.jpg)](https://www.youtube.com/watch?v=Mnve3tnEd-8)  
+
+You can also use ChatGPT when creating REPLs. During the REPL session you can ask *ChatGPT* about the code or any other question. Just start the message with `?` and the Smart Bot will ask ChatGPT and will post the answer. Example: `? How to create a new customer?`. If you send just the question mark without a prompt then ChatGPT will suggest next code line. Example: `?`  
+To send the results of a *SmartBot command* as input for a *ChatGPT* session, use `COMMAND ?? PROMPT`. Example: `bot help ?? how can I use the time off commands`. If you are on a thread you can send more SmartBot commands to the same session by using `COMMAND ?? PROMPT`.   
+
 
 #### Image Generation
+> for all users  
+
 `??i PROMPT`  
  `?i PROMPT`  
  `?ir`  
@@ -764,6 +890,7 @@ if using `?ir` will generate a new image using the session prompts.
 <img src="img/image_generation.png" width="400">  
 
 #### Image Variations
+> for all users  
 
 `?iv`  
 `?ivNUMBER`  
@@ -774,6 +901,7 @@ If an image is attached then it will generate temporary variations of the attach
 <img src="img/image_variations.png" width="400">  
 
 #### Image Editing
+> for all users  
 
 `?ie PROMPT`  
 It will edit the attached image with the supplied PROMPT. The supplied image needs to be an image with a transparent area.  
@@ -782,6 +910,7 @@ The PROMPT need to explain the final result of the image.
 <img src="img/image_editing.png" width="400">  
 
 #### Whisper
+> for all users  
 
 `?w PROMPT`  
 `?w`  
@@ -790,11 +919,71 @@ It will transcribe the audio file attached and perform the PROMPT indicated if s
 <img src="img/whisper.png" width="650">  
 
 #### Models
+> for all users  
 
 `?m`  
 `?m MODEL`  
+`chatgpt models`  
 It will return the list of models available or the details of the model indicated.  
 
+### Recap
+> for all users  
+
+`recap`  
+`my recap`  
+`recap from YYYY/MM/DD`  
+`recap from YYYY/MM/DD to YYYY/MM/DD`  
+`recap YYYY`  
+`recap #CHANNEL`  
+`my recap #CHANNEL`  
+`recap from YYYY/MM/DD #CHANNEL`  
+`recap from YYYY/MM/DD to YYYY/MM/DD #CHANNEL`  
+`recap YYYY #CHANNEL`  
+It will show a recap of the channel. If channel not supplied, it will show the recap of the current channel.  
+If 'my' is added, it will show also a recap of your messages.  
+If only one date is added, it will show the recap from that day to 31st of December of that year.  
+If only one year is added, it will show the recap from 1st of January to 31st of December of that year.  
+Examples:  
+>**_`recap`_**  
+>**_`my recap`_**  
+>**_`recap 2023`_**  
+>**_`recap from 2023/07/01 to 2023/12/31 #sales`_**  
+>**_`recap 2022 #sales`_**  
+
+<img src="img/command_recap.png" width="250">  
+
+### Summarize
+> for all users  
+
+`summarize`  
+`summarize since YYYY/MM/DD`  
+`summarize #CHANNEL`  
+`summarize #CHANNEL since YYYY/MM/DD`  
+`summarize URL_THREAD`  
+It will summarize using ChatGPT the messages in the channel since the date specified.  
+If no date is specified it will summarize the last 30 days.  
+If time off added using Time Off command it will summarize since your last time off started.  
+If no channel is specified it will summarize the current channel.  
+If a thread URL is specified it will summarize the thread.  
+If the command is used in a thread it will summarize the thread.  
+Examples:  
+>**_`summarize`_**  
+>**_`summarize since 2024/01/22`_**  
+>**_`summarize #sales`_**  
+>**_`summarize #sales since 2024/01/22`_**  
+>**_`summarize https://yourcompany.slack.com/archives/C111JG4V4DZ/p1622549264010700`_**  
+
+<img src="img/command_summarize.png" width="500">  
+
+### Personal Settings  
+On a DM with SmartBot you can call `set personal settings` command and supply your specific personal settings just for you. Then the command using those settings will be specific for you with the value indicated here.   
+Examples:  
+>**_`set personal settings ai.open_ai.access_token Axdd3SSccffddZZZDFFDxf7`_**  
+>**_`set personal settings ai.open_ai_chat_gpt.model gpt-4-turbo-preview`_**  
+>**_`set personal settings authorizations.confluence.host confluence.love.example.com`_**  
+>**_`set personal settings authorizations.confluence.authorization Bearer XDfjjdkAAAjjjdkkslsladjjjd`_**  
+
+Other commands: `delete personal settings SETTINGS_ID`, `get personal settings`, `get personal settings SETTINGS_ID`  
 
 ### Tips
 > for admins
@@ -814,7 +1003,7 @@ When uploading a file the message added to 'Add a message about the file' will b
 ```ruby
     when /^do something with my file/i
       if !files.nil? and files.size == 1 and files[0].filetype == 'yaml'
-        require 'nice_http'
+        require "nice_http"
         http = NiceHttp.new(host: "https://files.slack.com", headers: { "Authorization" => "Bearer #{config.token}" })
         res = http.get(files[0].url_private_download, save_data: './tmp/')
         # if you want to directly access to the content use: `res.data`