This repository has been archived by the owner on Aug 2, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 83
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #25 from microsoft/chrande/archive-redirect
docs: update readme to reflect archived
- Loading branch information
Showing
1 changed file
with
6 additions
and
184 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,192 +1,14 @@ | ||
| # ⚠ The content in this repo has been moved to [microsoft/botframework-sdk](https://github.com/microsoft/botframework-sdk) ⚠ | ||
|
|
||
| # Microsoft Bot Framework | ||
| This repository is no longer in use and no longer accepts contributions. Please go to [microsoft/botframework-sdk](https://github.com/microsoft/botframework-sdk) to make contirbutions. | ||
|
|
||
| ### [Click here to find out what's new with Bot Framework](./whats-new.md#whats-new) | ||
| ## Code of Conduct | ||
|
|
||
| The Microsoft Bot Framework is a comprehensive platform for building enterprise-grade conversational AI experiences. It includes a set of open source SDKs, tools, and services which enable developers to **build**, **test**, and **connect** bots that interact naturally with users, wherever they are. With the Microsoft Bot Framework, it is easy to create a bot with the ability to speak, listen, understand, and learn from your users with Azure Cognitive Services. | ||
|
|
||
|  | ||
|
|
||
| This repo lists the SDK, tools, and services needed to build a great conversational AI experience. Its role is to serve as a landing page and one place to find all the information required to get started. | ||
|
|
||
| - [Bot Framework Composer](#Bot-Framework-Composer) | ||
| - [Bot Framework SDK v4](#Bot-Framework-SDK-v4) | ||
| - [Bot Framework Solutions](#Bot-Framework-Solutions) | ||
| - [Azure Bot Service](#Azure-Bot-Service) | ||
| - [Bot Framework Emulator](#Bot-Framework-Emulator) | ||
| - [Bot Framework Web Chat](#Bot-Framework-Web-Chat) | ||
| - [Bot Framework Tools](#Bot-Framework-CLI-Tools) | ||
| - [Language Understanding](#Language-Understanding) | ||
| - [QnA Maker](#QnA-Maker) | ||
| - [Dispatch](#Dispatch) | ||
| - [Speech Services](#Speech-Services) | ||
| - [Adaptive cards](#Adaptive-Cards) | ||
| - [Analytics](#Analytics) | ||
| - [Bot Framework SDK v3](#Bot-Framework-SDK-v3) | ||
|
|
||
| ## Bot Framework Composer | ||
| [Bot Framework Composer (Preview)](https://github.com/microsoft/BotFramework-Composer/blob/stable/README.md) is an integrated development tool for developers and multi-disciplinary teams to build bots and conversational experiences with the Microsoft Bot Framework. Within this tool, you'll find everything you need to build a sophisticated conversational experience. | ||
|
|
||
| ## Bot Framework SDK v4 | ||
| The Bot Framework SDK v4 is an [open source SDK][1a] that enable developers to model and build sophisticated conversation using their favorite programming language. | ||
|
|
||
|
|
||
| | | C# | JS | Python | Java | | ||
| |---|:---:|:---:|:------:|:-----:| | ||
| |Stable Release |[4.7][1] | [4.7][2] | [4.7][3] | [Preview 3][3a]| | ||
| |Docs | [docs][5] |[docs][5] |[docs][5] | | | ||
| |Samples |[.NET Core][6], [WebAPI][10] |[Node.js][7] , [TypeScript][8], [es6][9] | [Python][11] | | | ||
|
|
||
| [1a]:https://github.com/microsoft/botframework-sdk/#readme | ||
| [1]:https://github.com/Microsoft/botbuilder-dotnet/#packages | ||
| [2]:https://github.com/Microsoft/botbuilder-js#packages | ||
| [3]:https://github.com/Microsoft/botbuilder-python#packages | ||
| [3a]:https://github.com/Microsoft/botbuilder-java#packages | ||
| [4]:https://github.com/Microsoft/botbuilder-java#packages | ||
| [5]:https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0 | ||
| [6]:https://github.com/Microsoft/BotBuilder-Samples/tree/master/samples/csharp_dotnetcore | ||
| [7]:https://github.com/Microsoft/BotBuilder-Samples/tree/master/samples/javascript_nodejs | ||
| [8]:https://github.com/Microsoft/BotBuilder-Samples/tree/master/samples/typescript_nodejs | ||
| [9]:https://github.com/Microsoft/BotBuilder-Samples/tree/master/samples/javascript_es6 | ||
| [10]:https://github.com/Microsoft/BotBuilder-Samples/tree/master/samples/csharp_webapi | ||
| [11]:https://github.com/microsoft/BotBuilder-Samples/tree/master/samples/python | ||
|
|
||
| <a name="V4-whats-new"></a> | ||
|
|
||
| ### Bot Framework SDK v4 preview features | ||
|
|
||
| - **Adaptive Dialogs** enable developers to build conversations that can be dynamically changed as the conversation progresses. Traditionally developers have mapped out the entire flow of a conversation up front, which limits the flexibility of the conversation. Adaptive dialogs allow them to be more flexible, to respond to changes in context and insert new steps or entire sub-dialogs into the conversation as it progresses. Additionally as with other SDK V4 concepts, we have defined adaptive dialogs such that they can be defined via [declarative][50] that are interpreted at runtime; which allows us to have tooling on top of this and integrate with services. [[Docs][48] | [C# samples][49]] | ||
|
|
||
| - **Language Generation**: Learning from our customers' experiences and bringing together capabilities first implemented by Cortana and Cognition teams, we are introducing Language Generation. It allows the developer to extract the embedded strings from their code and resource files and manage them through a Language Generation runtime and file format. Language Generation enable customers to define multiple variations on a phrase, execute simple expressions based on context, refer to conversational memory, and over time will enable us to bring additional capabilities all leading to a more natural conversational experience. [[Docs][44] | [C# samples][45]] | ||
|
|
||
| - **Common Expression Language**: Both Adaptive dialogs and Language Generation rely on and use a common expression language to power bot conversations. [[API][41]] | ||
|
|
||
| [40]:https://github.com/Microsoft/BotBuilder-Samples/tree/master/experimental/common-expression-language#readme | ||
| [41]:https://github.com/Microsoft/BotBuilder-Samples/blob/master/experimental/common-expression-language/api-reference.md | ||
| [43]:https://github.com/Microsoft/BotBuilder-Samples/tree/master/experimental/language-generation#readme | ||
| [44]:https://github.com/Microsoft/BotBuilder-Samples/tree/master/experimental/language-generation/docs | ||
| [45]:https://github.com/Microsoft/BotBuilder-Samples/tree/master/experimental/language-generation/csharp_dotnetcore | ||
| [46]:https://github.com/Microsoft/BotBuilder-Samples/tree/master/experimental/language-generation/javascript_nodejs/13.core-bot | ||
| [47]:https://github.com/Microsoft/BotBuilder-Samples/tree/master/experimental/adaptive-dialog#readme | ||
| [48]:https://github.com/Microsoft/BotBuilder-Samples/tree/master/experimental/adaptive-dialog/docs | ||
| [49]:https://github.com/Microsoft/BotBuilder-Samples/tree/master/experimental/adaptive-dialog/csharp_dotnetcore | ||
| [50]:https://github.com/Microsoft/BotBuilder-Samples/tree/master/experimental/adaptive-dialog/declarative | ||
|
|
||
| ### Botkit | ||
| [Botkit][100] is a developer tool and SDK for building chat bots, apps and custom integrations for major messaging platforms. Botkit bots `hear()` triggers, `ask()` questions and `say()` replies. Developers can use this syntax to build dialogs - now cross compatible with the latest version of Bot Framework SDK. | ||
|
|
||
| In addition, Botkit brings with it 6 platform adapters allowing Javascript bot applications to communicate directly with messaging platforms: [Slack][102], [Webex Teams][103], [Google Hangouts][104], [Facebook Messenger][105], [Twilio][106], and [Web chat][107]. | ||
|
|
||
| Botkit is part of Microsoft Bot Framework and is released under the [MIT Open Source license][101] | ||
|
|
||
| [100]:https://github.com/howdyai/botkit#readme | ||
| [101]:https://github.com/howdyai/botkit/blob/master/LICENSE.md | ||
| [102]:https://github.com/howdyai/botkit/tree/master/packages/botbuilder-adapter-slack#readme | ||
| [103]:https://github.com/howdyai/botkit/tree/master/packages/botbuilder-adapter-webex#readme | ||
| [104]:https://github.com/howdyai/botkit/tree/master/packages/botbuilder-adapter-hangouts#readme | ||
| [105]:https://github.com/howdyai/botkit/tree/master/packages/botbuilder-adapter-facebook#readme | ||
| [106]:https://github.com/howdyai/botkit/tree/master/packages/botbuilder-adapter-twilio-sms#readme | ||
| [107]:https://github.com/howdyai/botkit/tree/master/packages/botbuilder-adapter-web#readme | ||
|
|
||
| ## Bot Framework Solutions (Preview) | ||
|
|
||
| The [Bot Framework Solutions repository](https://github.com/Microsoft/botframework-solutions#readme) provides a set of templates, solution accelerators and skills to help build sophisticated conversational experiences. | ||
|
|
||
| <a name="Solutions-whats-new"></a> | ||
|
|
||
| - [**Virtual Assistant.**](https://aka.ms/bfvadocs) Customers and partners have a significant need to deliver a conversational assistant tailored to their brand, personalized to their users, and made available across a broad range of canvases and devices. <br/><br/> This brings together all of the supporting components and greatly simplifies the creation of a new bot project including: basic conversational intents, Dispatch integration, QnA Maker, Application Insights and an automated deployment. | ||
|
|
||
| - [**Skills.**](https://aka.ms/bfskillsdocs) A library of re-usable conversational skill building-blocks enabling you to add functionality to a Bot. We currently provide: Calendar, Email, Task, Point of Interest, Automotive, Weather and News skills. Skills include LUIS models, Dialogs, and integration code delivered in source code form to customize and extend as required. | ||
|
|
||
| - [**Analytics.**](https://github.com/Microsoft/AI/blob/master/docs/readme.md#analytics) Gain key insights into your bot’s health and behavior with the Bot Framework Analytics solutions, which includes: sample Application Insights queries, and Power BI dashboards to understand the full breadth of your bot’s conversations with users. | ||
|
|
||
| ## Azure Bot Service | ||
| Azure Bot Service enables you to host intelligent, enterprise-grade bots with complete ownership and control of your data. Developers can register and connect their bots to users on Skype, Microsoft Teams, Cortana, Web Chat, and more. [[Docs][28]] | ||
|
|
||
| * **Direct Line JS Client**: If you want to use the Direct Line channel in Azure Bot Service and are not using the WebChat client, the Direct Line JS client can be used in your custom application. [[Readme][30]] | ||
|
|
||
| <a name="ABS-whats-new"></a> | ||
|
|
||
| * **Direct Line Speech Channel**: We are bringing together the Bot Framework and Microsoft's Speech Services to provide a channel that enables streamed speech and text bi-directionally from the client to the bot application. To sign up, add the 'Direct Line Speech' channel to your Azure Bot Service. | ||
|
|
||
| [27]:https://azure.microsoft.com/en-us/services/bot-service/ | ||
| [28]:https://docs.microsoft.com/en-us/azure/bot-service/bot-service-overview-introduction?view=azure-bot-service-4.0 | ||
| [29]:https://docs.microsoft.com/en-us/azure/bot-service/bot-service-manage-channels?view=azure-bot-service-4.0 | ||
| [30]:https://github.com/Microsoft/BotFramework-DirectLineJS/blob/master/README.md | ||
|
|
||
| * **Better isolation for your Bot - Direct Line App Service Extension** : The Direct Line App Service Extension can be deployed as part of a VNET, allowing IT administrators to have more control over conversation traffic and improved latency in conversations due to reduction in the number of hops. Get started with Direct Line App Service Extension here. A VNET lets you create your own private space in Azure and is crucial to your cloud network as it offers isolation, segmentation, and other key benefits. | ||
|
|
||
| ## Bot Framework Emulator | ||
| The [Bot Framework Emulator][60] is a cross-platform desktop application that allows bot developers to test and debug bots built using the Bot Framework SDK. You can use the Bot Framework Emulator to test bots running locally on your machine or to connect to bots running remotely. [[Download latest][61] | [Docs][62]] | ||
|
|
||
| [60]:https://github.com/Microsoft/BotFramework-Emulator#readme | ||
| [61]:https://github.com/Microsoft/BotFramework-Emulator/releases/latest | ||
| [62]:https://docs.microsoft.com/en-us/azure/bot-service/bot-service-debug-emulator?view=azure-bot-service-4.0 | ||
|
|
||
| ## Bot Framework Web Chat | ||
| The Bot Framework [Web Chat][23] is a highly customizable web-based client chat control for Azure Bot Service that provides the ability for users to interact with your bot directly in a web page. [[Stable release][24] | [Docs][25] | [Samples][26]] | ||
|
|
||
| [23]:https://github.com/Microsoft/BotFramework-WebChat#readme | ||
| [24]:https://www.npmjs.com/package/botframework-webchat | ||
| [25]:https://github.com/Microsoft/BotFramework-WebChat/tree/master/doc | ||
| [26]:https://github.com/Microsoft/BotFramework-WebChat/tree/master/samples | ||
|
|
||
|
|
||
| ## Bot Framework CLI Tools | ||
| The Bot Framework CLI Tools is an [open source](https://github.com/microsoft/botframework-cli) collection of cross-platform command line tools designed to support building robust end-to-end development workflows. The new Bot Framework CLI tool replaces legacy standalone tools used to manage bots and related services. We've ported most of the tools and are in the process of porting the rest of them. BF CLI aggregates the collection of cross-platform tools into one cohesive and consistent interface. For the 4.6 release, we've ported Chatdown, QnAMaker, LuDown, and LuisGen. We plan to deprecate older versions of the tool in the future. [Docs] | ||
|
|
||
|
|
||
| ## Related Services | ||
|
|
||
| ### Language Understanding | ||
| A machine learning-based service to build natural language experiences. Quickly create enterprise-ready, custom models that continuously improve. Language Understanding Service(LUIS) allows your application to understand what a person wants in their own words. [[Docs][31] | [Add language understanding to your bot][32]] | ||
|
|
||
| [18]:https://github.com/Microsoft/botbuilder-tools/tree/master/packages/LUIS#readme | ||
| [19]:https://github.com/Microsoft/botbuilder-tools/tree/master/packages/QnAMaker#readme | ||
| [30]:https://www.luis.ai | ||
| [31]:https://docs.microsoft.com/en-us/azure/cognitive-services/LUIS/Home | ||
| [32]:https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-howto-v4-luis?view=azure-bot-service-4.0&branch=pr-en-us-1325&tabs=csharp | ||
|
|
||
| ### QnA Maker | ||
| [QnA Maker][33] is a cloud-based API service that creates a conversational, question-and-answer layer over your data. With QnA Maker, you can build, train and publish a simple question and answer bot based on FAQ URLs, structured documents, product manuals or editorial content in minutes. [[Docs][34] | [Add qnamaker to your bot][35]] | ||
|
|
||
| [33]:https://www.qnamaker.ai/ | ||
| [34]:https://aka.ms/qnamaker-docs-home | ||
| [35]:https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-howto-qna?view=azure-bot-service-4.0&branch=pr-en-us-1325&tabs=cs | ||
|
|
||
| ### Dispatch | ||
| Dispatch tool lets you build language models that allow you to dispatch between disparate components (such as QnA, LUIS and custom code). [[Readme](https://github.com/Microsoft/botbuilder-tools/blob/master/packages/Dispatch#readme)] | ||
|
|
||
| ### Speech Services | ||
| Speech Services convert audio to text, perform speech translation and text-to-speech with the unified Speech services. With the speech services, you can integrate speech into your bot, create custom wake words, and author in multiple languages. [[Docs](https://azure.microsoft.com/en-us/services/cognitive-services/speech-services/)] | ||
|
|
||
| ### Adaptive Cards | ||
| [Adaptive Cards](https://adaptivecards.io) are an open standard for developers to exchange card content in a common and consistent way, | ||
| and are used by Bot Framework developers to create great cross-channel conversatational experiences. | ||
|
|
||
| * **Open framework, native performance** - A simple open card format enables an ecosystem of shared tooling, seamless integration between apps, and native cross-platform performance on any device. | ||
| * **Speech enabled from day one** - We live in an exciting era where users can talk to their devices. Adaptive Cards embrace this new world and were designed from the ground up to support these new experiences. | ||
|
|
||
| ## Bot Framework SDK v3 | ||
|
|
||
| > Note: While we actively maintain the v3 SDK, we are focusing out attention on the v4 of the SDK. Read more on [SDK v3 long-term support](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-resources-bot-framework-faq?view=azure-bot-service-3.0#bot-framework-sdk-version-3-lifetime-support). | ||
| The Bot Framework SDK v3 includes SDKs that enable developers to model and build sophisticated conversation using their favorite programing language. | ||
|
|
||
| | | C# | JS | | ||
| |---|:---:|:---:| | ||
| |Stable Release |[3.20.1][11] | [3.16.0][12] | | ||
| |Docs | [docs][13] |[docs][13] | | ||
| |Samples |[C#][14] |[Node.js][15] | | ||
|
|
||
| [11]:https://www.nuget.org/packages/Microsoft.Bot.Builder/3.20.1 | ||
| [12]:https://www.npmjs.com/package/botbuilder/v/3.16.0 | ||
| [13]:https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-3.0 | ||
| [14]:https://github.com/Microsoft/BotBuilder-V3/tree/master/CSharp/Samples | ||
| [15]:https://github.com/Microsoft/BotBuilder-V3/tree/master/Node/examples | ||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
| For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
| contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. | ||
|
|
||
| ## Reporting Security Issues | ||
|
|
||
| Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at [secure@microsoft.com](mailto:secure@microsoft.com). You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the [MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in the [Security TechCenter](https://technet.microsoft.com/en-us/security/default). | ||
|
|
||
| Copyright (c) Microsoft Corporation. All rights reserved. |