139 строки
23 KiB
Markdown
139 строки
23 KiB
Markdown
# 
|
|
|
|
### [What's new with Bot Framework](https://docs.microsoft.com/en-us/azure/bot-service/what-is-new?view=azure-bot-service-4.0)
|
|
|
|
This repository contains code for the .NET version of the [Microsoft Bot Framework SDK](https://github.com/Microsoft/botframework-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](https://github.com/Microsoft/botbuilder-js), [Python](https://github.com/Microsoft/botbuilder-python) and [Java (preview)](https://github.com/Microsoft/botbuilder-java) are also available.
|
|
|
|
To get started building bots using the SDK, see the [Azure Bot Service Documentation](https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0).
|
|
|
|
For more information jump to a section below.
|
|
|
|
* [Build status](#build-status)
|
|
* [Packages](#packages)
|
|
* [Getting started](#getting-started)
|
|
* [Getting support and providing feedback](#getting-support-and-providing-feedback)
|
|
* [Contributing and our code of conduct](contributing-and-our-code-of-conduct)
|
|
* [Reporting security sssues](#reporting-security-issues)
|
|
|
|
## Build Status
|
|
|
|
| Branch | Description | Build Status | Coverage Status | Windows Bot Test Status | Linux Bot Test Status |
|
|
|----|---------------|--------------|-----------------|--|--|
|
|
|Main | 4.19.* Preview Builds |[](https://fuselabs.visualstudio.com/SDK_v4/_build/latest?definitionId=277&branchName=main) |[](https://coveralls.io/github/microsoft/botbuilder-dotnet?branch=main) | [](https://fuselabs.visualstudio.com/SDK_v4/_build/latest?definitionId=834&branchName=main) | [](https://fuselabs.visualstudio.com/SDK_v4/_build/latest?definitionId=779&branchName=main)
|
|
|
|
## Packages
|
|
|
|
| Name | Released Package | Daily Build
|
|
|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|
|
|
| Microsoft.Bot.Builder | [](https://www.nuget.org/packages/Microsoft.Bot.Builder/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder) |
|
|
| Microsoft.Bot.Builder.Adapters.Facebook | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Adapters.Facebook/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Adapters.Facebook) |
|
|
| Microsoft.Bot.Builder.Adapters.Slack | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Adapters.Slack/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Adapters.Slack) |
|
|
| Microsoft.Bot.Builder.Adapters.Twilio | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Adapters.Twilio/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Adapters.Twilio) |
|
|
| Microsoft.Bot.Builder.Adapters.Webex | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Adapters.Webex/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Adapters.Webex) |
|
|
| Microsoft.Bot.Builder.AI.LUIS | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.AI.LUIS/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.AI.LUIS) |
|
|
| Microsoft.Bot.Builder.AI.Orchestrator | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.AI.Orchestrator/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.AI.LUIS) |
|
|
| Microsoft.Bot.Builder.AI.QnA | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.AI.Qna/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.AI.QnA) |
|
|
| Microsoft.Bot.Builder.ApplicationInsights | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.ApplicationInsights/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.ApplicationInsights) |
|
|
| Microsoft.Bot.Builder.Azure | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Azure/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Azure) |
|
|
| Microsoft.Bot.Builder.Azure.Blobs | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Azure.Blobs/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Azure.Blobs) |
|
|
| Microsoft.Bot.Builder.Azure.Queues | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Azure.Queues/)| [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Azure.Queues) |
|
|
| Microsoft.Bot.Builder.Dialogs | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Dialogs/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Dialogs) |
|
|
| Microsoft.Bot.Builder.Dialogs.Adaptive | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Dialogs.Adaptive/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Dialogs.Adaptive) |
|
|
| Microsoft.Bot.Builder.Dialogs.Adaptive.Runtime | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Dialogs.Adaptive.Runtime/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Dialogs.Adaptive.Runtime) |
|
|
| Microsoft.Bot.Builder.Dialogs.Adaptive.Testing | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Dialogs.Adaptive.Testing/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Dialogs.Adaptive.Testing) |
|
|
| Microsoft.Bot.Builder.Dialogs.Debugging | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Dialogs.Debugging/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Dialogs.Debugging) |
|
|
| Microsoft.Bot.Builder.Dialogs.Declarative | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Dialogs.Declarative/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Dialogs.Declarative) |
|
|
| Microsoft.Bot.Builder.Integration.ApplicationInsights.Core | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Integration.ApplicationInsights.Core/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Integration.ApplicationInsights.Core) |
|
|
| Microsoft.Bot.Builder.Integration.ApplicationInsights.WebApi | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Integration.ApplicationInsights.WebApi/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Integration.ApplicationInsights.WebApi) |
|
|
| Microsoft.Bot.Builder.Integration.AspNet.Core | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Integration.AspNet.Core/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Integration.AspNet.Core) |
|
|
| Microsoft.Bot.Builder.Integration.AspNet.WebApi | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Integration.AspNet.WebApi/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Integration.AspNet.WebApi) |
|
|
| Microsoft.Bot.Builder.LanguageGeneration | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.LanguageGeneration/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.LanguageGeneration) |
|
|
| Microsoft.Bot.Builder.Parsers.LU | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Parsers.LU/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Parsers.LU) |
|
|
| Microsoft.Bot.Builder.TemplateManager | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.TemplateManager/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.TemplateManager) |
|
|
| Microsoft.Bot.Builder.Testing | [](https://www.nuget.org/packages/Microsoft.Bot.Builder.Testing/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Builder.Testing) |
|
|
| Microsoft.Bot.Configuration | [](https://www.nuget.org/packages/Microsoft.Bot.Configuration/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Configuration) |
|
|
| Microsoft.Bot.Connector | [](https://www.nuget.org/packages/Microsoft.Bot.Connector/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Connector) |
|
|
| Microsoft.Bot.Schema | [](https://www.nuget.org/packages/Microsoft.Bot.Schema/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Schema) |
|
|
| Microsoft.Bot.Streaming | [](https://www.nuget.org/packages/Microsoft.Bot.Streaming/) | [](https://botbuilder.myget.org/feed/botbuilder-v4-dotnet-daily/package/nuget/Microsoft.Bot.Streaming) |
|
|
|
|
|
|
## 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](dailyBuilds.md).
|
|
- To use the daily builds published to MyGet, please follow the instructions [here](UsingMyGet.md). **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](https://botbuildersdkblobstorag2.blob.core.windows.net/sdk-dotnet-dependency-reports/latest/InterdependencyGraph.html) for our libraries.
|
|
|
|
## Getting Started
|
|
To get started building bots using the SDK, see the [Azure Bot Service Documentation](https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0).
|
|
|
|
The [Bot Framework Samples](https://github.com/microsoft/botbuilder-samples) includes a rich set of samples repository.
|
|
|
|
If you want to debug an issue, would like to [contribute](#contributing), or understand how the Bot Builder SDK works, instructions for building and testing the SDK are below.
|
|
|
|
### Prerequisites
|
|
- [Git](https://git-scm.com/downloads)
|
|
- [Visual Studio](https://www.visualstudio.com/)
|
|
|
|
### Clone
|
|
Clone a copy of the repo:
|
|
|
|
```bash
|
|
git clone https://github.com/Microsoft/botbuilder-dotnet.git
|
|
```
|
|
|
|
Change to the SDK's directory:
|
|
|
|
```bash
|
|
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](https://github.com/Microsoft/botbuilder-dotnet/issues) should be used for bugs and feature requests.
|
|
|
|
### Stack overflow
|
|
[Stack Overflow](https://stackoverflow.com/questions/tagged/botframework) 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](https://azure.microsoft.com/en-gb/services/bot-service/), you can take advantage of the available [Azure support options](https://azure.microsoft.com/en-us/support/options/).
|
|
|
|
### Twitter
|
|
We use the [@msbotframework](https://twitter.com/msbotframework) account on twitter for announcements and members from the development team watch for tweets for [@msbotframework](https://twitter.com/msbotframework).
|
|
|
|
### Gitter Chat Room
|
|
The [Gitter Channel](https://gitter.im/Microsoft/BotBuilder) 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](./contributing.md) for more information.
|
|
|
|
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.
|
|
|
|
Licensed under the [MIT](./LICENSE.md) License.
|
|
|