Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 32 Current »

You can configure BusinessGPT chatbot to be available as a Slack bot from Slack channels.

How to add the bot

To add the bot to a channel - simply mention the bot name in any channel in the following way:

@BusinessGPT

After this, Slack will offer to add the bot to the channel.

image-20240910-072404.png

Bot commands

/?- show end-user help

/config - show admin help on how to configure the bot

/setBotConfiguration- configure the bot

/getBotConfiguration- show existing configuration

How to configure the Bot

Next you need to configure the Bot with the chat scope and other parameters explained below:

  • API Key- the is the key of the user that has created the BGT bot. To get the Key go to the user settings in the BGD. see here: https://agatsoftware.atlassian.net/wiki/spaces/VA/pages/3284697089/BusinessGPT+Public+API+for+integration#Getting-API-KEY

  • DataSource (private and public=both, public, private). This is currently set by default to “Company and public” and can be overwritten by the user, so it does not need to be configured.

  • PrivateDataSource(Content, Collection, All)
    Note that if you allow all, any user in the channel can get answers from all the content you have permission to.

  • PrivateDataID (The ID of the content or the collection, not needed for All)

  • AIModel (optional. Default will be as for the user. Available values: GPT3_5, GPT4)

  • ChatId (optional): If provided, the question will be added to the existing chat with an external chat ID equal to the provided value. If no chat exists, a new one will be created.

  • ChatName (optional)- the name of the chat that appears in the auditing

The configuration is saved in the setting under the value “SlackBotConfigurations” and contains a JSON with a list of all channels and, for each channel, the relevant values (scop. id etc)

The bot will send the following parameters:

Prompt

Channel name

User name

AI service = SlackBot

Bot help

The bot supports help by typing businessGPT/?

Once asking for help, the bot shows the following text:

Welcome to your BusinessGPT Slack bot!


Bot Overview
[Show the help that is configured in the setup text]

Bot data source knowledge base

The bot's data sources are configured by the admin who set it up.

The bot can be configured to give answers by one of the following options:

To change the data source, type one of the above options based on the following example:

@BusinessGPT /public write a Python script to generate random numbers

Data source Notes

  1. Use public when possible to speed up the answer and give better answers.

  2. When set to Private, the bot will suggest using public if it does not find the answer.

  3. When set to both, the bot will indicate the source so the user can understand whether the answer was from public or private data.

For admin help, please type

@BusinessGPT /admin

Admin help:

Once typing /admin, the user will see the following text

Admin help:
Overview
To set up the bot, you need access to the BusinessGPT dashboard. When adding the bot to a channel, you configure it once to connect it to a content item in the BusinessGPT dashboard with the required knowledge. The content item can be a document, a site, or multiple items bundled as a collection.

Configuring the Bot

To set the values, type text as in the example below:

Configuration example

@BusinessGPT /setBotConfiguration DataSource=private ,PrivateDataSource=content-item, PrivateDataID=XXX , APIKey=YYYY , ChatName=ZZZZ, help=You can ask questions based on our Jira and confluence technical documentation. This bot, by default, will only answer based on the company’s private data.

Notes:

  1. DataSource possible values: both,private,public

  2. PrivateDataSource possible values: content-item/collection/all

  3. All parameters are case insensitive)

Additional configuration help

  1. For help on the parameters, please go here. https://agatsoftware.atlassian.net/wiki/spaces/VA/pages/3548119043/BusinessGPT+Slack+chatbot#Admin-bot-configuration-parameters-help

Viewing bot configuration

To review the existing value type

@BusinessGPT /getBotConfiguration

Admin bot configuration parameters help

DataSource

  1. Both -The bot will first try to answer based on the content configured by the user who set it up. If it does not manage to answer, it will try to answer using public pre-trained knowledge.

  2. Public- Get answers from pre-trained public knowledge only and not search for company private data. For better performance when, you know you don’t need company data.

  3. Prviate - Get answers only from the private company data that was configured for the bot

PrviateDataSource

  1. Content-item - Is used for a specific content item, such as a document or a site.

  2. Collection- A bundle of several content items. For example, several documents

  3. All - All the data the user who set the bot can access. In this case, it is recommended to set up a specific user and not use the Admin API key, as admins typically have broad access.

PrivateDataID

The ID of the data source - whether collection or content item.
To get the ID triple-click the line and copy the value of the content item or collection

APIKey

You can get the API key from the field API KEY in the user settings. A dedicated user for the bot is recommended to limit access to relevant content only.

Channel name

The value of the channel name will be displayed in the BsuinessGPT auditing and is free text and optional

Help

The value of help is displayed in the end-user help under the title of the overview. You can put here text explaining the bot scope.

  • No labels