/botbuilder-dotnet

Welcome to the Bot Framework SDK for .NET repository, which is the home for the libraries and packages that enable developers to build sophisticated bot applications using .NET.

Primary LanguageC#MIT LicenseMIT

Bot Framework for dotnet

This repository contains code for the .NET version of the Microsoft Bot Framework SDK, which is part of the Microsoft Bot Framework - a comprehensive framework for building enterprise-grade conversational AI experiences.

This SDK enables developers to model conversation and build sophisticated bot applications using .NET. SDKs for JavaScript, Python and Java (preview) are also available.

To get started building bots using the SDK, see the Azure Bot Service Documentation.

For more information jump to a section below.

Build Status

Branch Description Build Status Coverage Status Windows Bot Test Status Linux Bot Test Status
Main 4.19.* Preview Builds Build Status Coverage Status Tests Status Tests Status

Packages

Name Released Package Daily Build
Microsoft.Bot.Builder BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Adapters.Facebook BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Adapters.Slack BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Adapters.Twilio BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Adapters.Webex BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.AI.LUIS BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.AI.Orchestrator BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.AI.QnA BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.ApplicationInsights BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Azure BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Azure.Blobs BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Azure.Queues BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Dialogs BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Dialogs.Adaptive BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Dialogs.Adaptive.Runtime BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Dialogs.Adaptive.Testing BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Dialogs.Debugging BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Dialogs.Declarative BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Integration.ApplicationInsights.Core BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Integration.ApplicationInsights.WebApi BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Integration.AspNet.Core BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Integration.AspNet.WebApi BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.LanguageGeneration BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Parsers.LU BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.TemplateManager BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Builder.Testing BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Configuration BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Connector BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Schema BotBuilder Badge BotBuilder Badge
Microsoft.Bot.Streaming BotBuilder Badge BotBuilder Badge

Daily Feeds

The daily feeds are published to Azure Artifacts and MyGet.

  • The Azure Artifacts daily feed is our preferred method to obtain the most recent Bot Framework NuGet packages. To use the daily builds published to Azure Artifacts, use: https://pkgs.dev.azure.com/ConversationalAI/BotFramework/_packaging/SDK/nuget/v3/index.json

  • For detailed instructions to consume the daily builds in Azure Artifacts visit this page.

  • To use the daily builds published to MyGet, please follow the instructions here. NOTE: The MyGet feed will be depecrated soon. Please use the Azure Artifacts daily feed instead.

Dependency Graph

To view our libraries' interdependencies, you can refer to the dependency graph for our libraries.

Getting Started

To get started building bots using the SDK, see the Azure Bot Service Documentation.

The Bot Framework Samples includes a rich set of samples repository.

If you want to debug an issue, would like to contribute, or understand how the Bot Builder SDK works, instructions for building and testing the SDK are below.

Prerequisites

Clone

Clone a copy of the repo:

git clone https://github.com/Microsoft/botbuilder-dotnet.git

Change to the SDK's directory:

cd botbuilder-dotnet

Build and test locally

Open Microsoft.Bot.Builder.sln in Visual Studio. On the menu bar, choose Build > Build Solution.

When the solution is built, local NuGet package files (.nupkg) are generated for each project and are available under the outputPackages directory. You can add this folder to your NuGet Package Manager source list in Visual Studio (choose Tools > NuGet Package Manager > Package Manager Settings from the Visual Studio menu and add an additional Package Sources from there), allowing you to consume these in your local projects.

Getting support and providing feedback

Below are the various channels that are available to you for obtaining support and providing feedback. Please pay carful attention to which channel should be used for which type of content. e.g. general "how do I..." questions should be asked on Stack Overflow, Twitter or Gitter, with GitHub issues being for feature requests and bug reports.

Github issues

Github issues should be used for bugs and feature requests.

Stack overflow

Stack Overflow is a great place for getting high-quality answers. Our support team, as well as many of our community members are already on Stack Overflow providing answers to 'how-to' questions.

Azure Support

If you issues relates to Azure Bot Service, you can take advantage of the available Azure support options.

Twitter

We use the @msbotframework account on twitter for announcements and members from the development team watch for tweets for @msbotframework.

Gitter Chat Room

The Gitter Channel provides a place where the Community can get together and collaborate.

Contributing and our code of conduct

We welcome contributions and suggestions. Please see our contributing guidelines for more information.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact 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. 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 key, can be found in the Security TechCenter.

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License.