Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 10.6 KB

README.md

File metadata and controls

76 lines (53 loc) · 10.6 KB

Build Status

Bot Builder Community - JavaScript Extensions

This repository is part of the Bot Builder Community Project and contains Bot Builder Extensions for the JavaScript SDK, including middleware, dialogs, helpers and more. Other repos within the Bot Builder Community Project exist for extensions for .NET, Python, Java and tools - you can find our other repos under our GitHub organisation for the project.

To see a list of current extensions available for the Bot Builder JavaScript SDK, use the links below to jump to a section.

Installation

Each extension, such as middleware or recognizers, is available individually from NPM in the @botbuildercommunity scope. See each individual component description for installation details and links.

Contributing and Reporting Issues

We welcome and encourage contributions to this project, in the form of bug fixes, enhancements or new extensions. Please fork the repo and raise a PR if you have something you would like us to review for inclusion. If you want to discuss an idea first then the best way to do this right now is to raise a GitHub issue or reach out to one of us on Twitter.

Storage

The following alternative storage implementations are currently available;

Name Description Sample? NPM
Azure Table storage Use Azure Table Storage in your bot. NPM Version
DynamoDB storage Use DynamoDB storage implementation in your bot. NPM Version
MongoDB storage Use MongoDB storage implementation in your bot. NPM Version
MS SQL storage Use Microsoft SQL Server storage implementation in your bot. Sample NPM Version

The Azure Table Storage package has been deprecated from Microsoft's botbuilder-js repository, and is being taken over by the community.

Dialogs and Prompts

The following dialogs are currently available;

Name Description Sample? NPM
Dialog prompts A variety of prompts using the Microsoft Recognizers Text suite, such as currency, temperature, age and dimension. Sample NPM Version

Middleware

The following pieces of middleware are currently available;

Name Description Sample? NPM
Activity Type middleware Simple middleware component for intercepting and automatically handling messages based on activity type. Sample NPM Version
AWS Comprehend middleware Use Amazon's AWS Comprehend for sentiment analysis, key phrases, language detection, and entity extraction. Sample NPM Version
Google Language middleware Use Google Cloud Platform's Natural Language API for sentiment analysis, categories, and entity extraction. Sample NPM Version
Spell Check middleware Use Cognitive Services Spell Check API to detect misspellings and correct these. Sample NPM Version
Text Analytics middleware Use Cognitive Services Text Analytics API for sentiment analysis, language detection, key phrases and entity extraction. Sample NPM Version
Text Recognizer middleware Use the Microsoft Recognizers Text Suite for recognizing certain text sequences. NPM Version
Watson NLU middleware Use IBM Watson's NLU for sentiment analysis, key phrases, categories, concepts, emotion detection, and entity extraction. Sample NPM Version

Adapters

The following adapters can be used to expose your bot on additional channels not supported by the Azure Bot Service, such as Twilio WhatsApp and Twitter.

Name Description Sample? NPM
Alexa Adapter (preview) A platform adapter for Amazon Alexa. Includes broad support for Alexa Skills capabilities, including devices with displays, Alexa Cards, access to user profile data and the ability to send Progressive Responses. Sample NPM Version
Console adapter A platform adapter for the console / terminal. NPM Version
Twilio WhatsApp adapter A platform adapter for Twilio WhatsApp. Includes support for proactive messaging, sending attachments and sending location messages. Sample NPM Version
Twitter adapter A platform adapter for Twitter. Supports Twitter status updates and direct messages (DM's). Sample NPM Version

The following packages are available from Botkit, and work with both the Bot Framework and Botkit.

Name Description NPM
botbuilder-adapter-facebook A platform adapter for Facebook Messenger NPM Version
botbuilder-adapter-hangouts A platform adapter for Google NPM Version
botbuilder-adapter-slack A platform adapter for Slack NPM Version
botbuilder-adapter-twilio-sms A platform adapter for Twilio SMS NPM Version
botbuilder-adapter-webex A platform adapter for Webex Teams NPM Version