howdyai / botkit-docs Goto Github PK

Wordhop re-branded as Janis.ai over a year ago.
Please update the Repo link to https://github.com/Janis-ai/npm-janis
Also Botkit plugin name is: Janis.ai
Plugin description:
Janis is an AI management toolkit that enables teams working in Slack to collaborate on AI training, monitor bots for problems, and quickly resolve and prevent business-impacting incidents.

I can't help but feel this readme/doc whatever is heavily outdated. I get the bot.startConversation is not a function message, so my best guess is that it was replaced by something else. Where can I get the latest updated docs available? the main page is a mess tbh.

The built in storage system was only ever intended to be used as a "getting started" mechanism, and to ease the storage and handling of oauth tokens from Slack.

The documentation should reflect this, and should discourage developers from using it for other purposes.

Docs should also discuss passing a customized handler to Slack that properly handles team data.

In the docs/readme-middlewares.md file -> the Statistics, Metrics, and CRM section -> Botimize is no longer available.

Suggest: Remove this item.

Do you want me to make the changes and raise a Pull Request?

Hey, folks!

We've been experimenting with Botkit for some tutorials and have been observing a small UX bug that leads to user error. Let me know if you have questions or concerns.

Problem:
The sidebar in the documentation says "Webex Teams" under platforms. This is confusing because the official name of the product is "Cisco Webex Teams" and most people colloquially refer to the product as "Cisco Webex", not "Webex Teams". Additionally, there's a high probability of user error because "Cisco Jabber" appears directly below "Webex Teams" in the list and on a quick scan you could easily click the wrong link if you were scanning for the word Cisco.

Proposed Solution:
Update the name of the sidebar link to "Cisco Webex Teams" from "Webex Teams".

On the Storing Information Doc there is a broken link pointing to a javascript file the doesn't exist. storage_test.js is the link in problem. Is the link somewhere else or should this be removed?

howdyai/botkit#1323

I am trying to add a simple points/karma system to my slack bot
https://github.com/paircast/mlh-webex-bot-karma
however I am getting an error trying to use the middleware

` controller.middleware.heard.use(function(bot, message, next){
let text = message.text.split(" ");
let found = false;
if(text[0] == "sdpoints"){
// perform the code that adds points to a user
}else if(text[0] == "sdremove"){
// perform the code to remove a specific user
}else if(text[0] == "sdreset"){
// perform the code to set the users points to zero
}else if(text[0] == "sduser"){
// perform the code to add a new user
}else if(text[0] == "sdtally"){
// perform the code to tally up the results so far.
}else if(text[0] == "sdhelp"){
//send the help response
message.user_profile = "Here is a list of things you can say:\n1. /points '# of points' 'Name of person'\n2. /tally\n3. /remove 'users name'\n4. /user 'new users name'\n5. /reset";
next();
}else{
//send by default the help response
}
});

controller.hears(['sdpoints (.)', 'sdremove (.)', 'sdreset', 'sduser (.*)', 'sdtally', 'sdhelp'], 'direct_message,direct_mention', function(bot, message){
console.log("Made it to the hears reply section", message.user_profile);
bot.reply(message, message.user_profile);
});`

The issue is with controller.hears('keyword', 'message')
If its being used with the message and the bot responds with that keyword it keeps replying back to it's own message.
For example, if the bot's reply is bot.reply(message, 'keyword);
then it will just keep repeating keyword over and over
The only workarounds I have found for this is to either:

1. user 'direct_message, mention, direct_mention'
2. use reply messages that don't contain the keywords

The problem with method 1 is that I can't use a common.js file to work for both Teams/Slack/Discord, I have to create separate .js files for each channel to do the same exact things.

Method 2 will work but I am worried that if it responds to another message (like a random message from my ChatGPT integration) that does contain a keyword for some other controller.hears message it will cause an issue of it responding unnecessarily.

I am thinking the only thing to do is to have it listen for it's own bot identity or app ID and then return if it sees itself but I am not really sure how to find the Bot ID. If its the App ID in api.slack that did not work for me.

.

`	//Stock Quotes
	controller.hears('stock price', 'message,direct_message,direct_mention,mention', async function(bot, message) {
		const stock = message.text.match(/stock price of (\w+)/i)[1];;
		const url = `https://www.alphavantage.co/query?function=GLOBAL_QUOTE&symbol=${stock}&apikey=${process.env.STOCKAPI}`;
		try {
			const body = await rp({ uri: url, json: true });
			if (body["Error Message"]){
				bot.reply(message, 'Invalid stock symbol');
				return;
			}
			const stockPrice = body["Global Quote"]["05. price"];
			const roundedStockPrice = Math.round(stockPrice * 100) / 100;
			bot.reply(message, `The latest stock price of ${stock} is $${roundedStockPrice}`);
			return;
		} catch (err) {
			console.log(err);
			bot.reply(message, 'Sorry, I was unable to retrieve the stock price.');
		}
	});`

Hi, is there a way to share variables between to scripts with convo.setVar??

Hi, I'm working on using https://github.com/howdyai/botkit-docs/blob/master/docs/howto/build_connector.md as boilerplate for building the Rocket.Chat adapter. However, there's a couple errors in the example code.

See bot.say(message, cb) - the message variable is never defined. Is that meant to be resp?

Also, looking at other connectors, like Slackbot, they don't seem to add the same methods, like .send - Is there a difference in how the built in connectors are designed, compared to external connectors? Maybe some quick context should be added to the description on this doc.

Thanks.

This document still makes reference to Teams being in developer preview, which is no longer the case.

This document should be refreshed, and maybe also point to Microsoft's new "Teams App Studio" plugin.

Slack added a new feature called Block Kit to increase flexibility when composing interactive messages. The previous way of using attachments is now considered outdated. See https://api.slack.com/messaging/interactivity/enabling for more details.

Hi all, 👋

This follows my current work on "Allow Promises when on Facebook API calls" of botkit, actually still in PR #1520.

I would like to have a first feedback on how to properly document the promise way of some methods, in addition to the classical callback way.

Here is an example, currently in my fork https://github.com/htaidirt/botkit-docs/commit/c8f393ce2739d4c5fc3c7466650cd6608101d351. Given your feedbacks, I'll continue documenting similarly the remaining methods.

Thanks