-
Notifications
You must be signed in to change notification settings - Fork 532
[4728451][Doc Improvement] rename Bot Framework SDK and TeamsFX SDK-1 #13421
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,14 +18,14 @@ A bot is also referred to as a chatbot or conversational bot. It's an app that r | |
|
||
### Bot APIs | ||
|
||
The [Bot Framework](https://dev.botframework.com/) is a rich SDK used to create bots using C#, Java, Python, and JavaScript. If you already have a bot that is based on the Bot Framework, you can easily modify it to work in Teams. Use either C# or Node.js to take advantage of our [SDKs](/azure/bot-service/bot-service-overview?view=azure-bot-service-4.0&preserve-view=true). | ||
The [Teams AI library](/microsoftteams/platform/teams-ai-library/) is a rich SDK used to create bots using C#, Python, and JavaScript. Use either C# or Node.js to take advantage of our [SDKs](/microsoftteams/platform/teams-ai-library/why). | ||
|
||
### Code samples - Bots | ||
|
||
|Sample name | Description | .NETCore | Node.js | Python | Java| Manifest| | ||
|----------------|-----------------|--------------|----------------|----------------|----------------|----------------| | ||
| Teams conversation bot | This app demonstrates bot conversation events, supporting Adaptive Cards, read receipts, and message update events. It includes immersive reader support for accessibility. | [View](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/bot-conversation/csharp) | [View](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/bot-conversation/nodejs) | [View](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/bot-conversation/python) |[View](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/bot-conversation/java) |[View](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/bot-conversation/csharp/demo-manifest/bot-conversation.zip) | ||
|Bot samples | Set of bot framework v4 samples | [View](https://github.com/OfficeDev/Microsoft-Teams-Samples#bots-samples-using-the-v4-sdk) | [View](https://github.com/OfficeDev/Microsoft-Teams-Samples#bots-samples-using-the-v4-sdk) | [View](https://github.com/OfficeDev/Microsoft-Teams-Samples#bots-samples-using-the-v4-sdk) |[View](https://github.com/OfficeDev/Microsoft-Teams-Samples#bots-samples-using-the-v4-sdk) | | ||
|Bot samples | Set of bot samples | [View](https://github.com/OfficeDev/Microsoft-Teams-Samples#bots-samples-using-the-v4-sdk) | [View](https://github.com/OfficeDev/Microsoft-Teams-Samples#bots-samples-using-the-v4-sdk) | [View](https://github.com/OfficeDev/Microsoft-Teams-Samples#bots-samples-using-the-v4-sdk) |[View](https://github.com/OfficeDev/Microsoft-Teams-Samples#bots-samples-using-the-v4-sdk) | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's ok to use "Bot" for now. In future, "bot" should be repalced by "agent". As discussed with Surbhi, this replacement will be done in future iterations. |
||
|
||
## Message extensions | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
title: Bots and Agents | ||
description: Learn to build a basic chatbot using Microsoft 365 Agents Toolkit, Bot Framework SDK. Additionally, learn to build a custom engine agent. | ||
description: Learn to build a basic chatbot using Microsoft 365 Agents Toolkit, Teams AI library. Additionally, learn to build a custom engine agent. | ||
ms.localizationpriority: high | ||
ms.date: 09/25/2024 | ||
ms.topic: conceptual | ||
|
@@ -25,19 +25,19 @@ If you want to create your own bot, here's a list of tools and platforms to help | |
| --- | --- | --- | | ||
| 1. | Bot type | - Custom engine agent <br> - Conventional bot | | ||
| 2. | Bot capabilities | Choose the capabilities you want to build in your bot: <br> • Conversational capability <br> • Notification capability <br> • Workflow capability <br> • Command capability | | ||
| 3. | Tools and Platforms | - **Teams AI library**: <br> Teams AI Library is a set of tools for developing agents and applications for Microsoft Teams. It enhances developer experience, making it easier to create powerful agents and applications. <br> If you already have an agent or an application, you can migrate it to use Teams AI library for adding more advanced capabilities. <br><br> For more information see [Teams AI library](/microsoftteams/platform/teams-ai-library) <br><br> - **Bot Framework SDK**: The [Bot Framework](https://dev.botframework.com/) SDK allows you to create bots using C#, Python, and JavaScript. You can modify existing bots to work in Teams using C# or Node.js. The [SDK](/azure/bot-service/bot-service-overview?view=azure-bot-service-4.0&preserve-view=true) extends Bot Builder to: <br> • Use specialized card types like the connector card for Microsoft 365 Groups. <br> • Set Teams-specific channel data on activities. <br> • Process message extension requests. <br> You can develop Teams apps with any web technology and call the [Bot Framework REST APIs](/bot-framework/rest-api/bot-framework-rest-overview) directly, ensuring token handling in all cases. <br> <br> - **Microsoft 365 Agents Toolkit** (previously known as Teams Toolkit): <br> Agents Toolkit makes it simple to start developing bot apps for Teams. You can use a project template for common custom bot app scenarios (LOB app) or start from a sample. <br> For more information, see [tools and SDKs](../concepts/build-and-test/tool-sdk-overview.md). <br> <br> - **Azure AI services**: <br> Azure AI services offer tools and frameworks for building, deploying, and managing intelligent applications. The Azure AI Foundry tool is crucial for creating and testing custom engine agents to manage and test AI models. <br> For more information, see [Azure AI Foundry](https://ai.azure.com/). | | ||
| 3. | Tools and Platforms | - **Teams AI library**: <br> Teams AI Library is a set of tools for developing agents and applications for Microsoft Teams. It enhances developer experience, making it easier to create powerful agents and applications. <br> If you already have an agent or an application, you can migrate it to use Teams AI library for adding more advanced capabilities. <br><br> For more information see [Teams AI library](/microsoftteams/platform/teams-ai-library) <br> <br> - **Microsoft 365 Agents Toolkit** (previously known as Teams Toolkit): <br> Agents Toolkit makes it simple to start developing bot apps for Teams. You can use a project template for common custom bot app scenarios (LOB app) or start from a sample. <br> For more information, see [tools and SDKs](../concepts/build-and-test/tool-sdk-overview.md). <br> <br> - **Azure AI services**: <br> Azure AI services offer tools and frameworks for building, deploying, and managing intelligent applications. The Azure AI Foundry tool is crucial for creating and testing custom engine agents to manage and test AI models. <br> For more information, see [Azure AI Foundry](https://ai.azure.com/). | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same as my first comment - is "library" a set of tools? Or just a collection of methods and functions? @MSFTRickyCastaneda can you weigh in here? |
||
| 4. | Bot registration service | - Azure AD <br> - Developer Portal | | ||
| 5. | Advanced bot capabilities | - Call and media bot <br> - Access data using MS Graph <br> - SSO <br> - Bot on Mobile <br> - Support for Microsoft 365 Copilot Chat | | ||
|
||
## Build a bot | ||
|
||
Let's start by building a bot. You can use Agents Toolkit, Bot Framework SDK, or Teams AI library. After you build a conventional Teams bot app, you can add the AI layer to your bot to elevate it. | ||
Let's start by building a bot. You can use Agents Toolkit, or Teams AI library. After you build a conventional Teams bot app, you can add the AI layer to your bot to elevate it. | ||
|
||
### Build a conventional Teams bot app | ||
|
||
| # | I want to build ... | Here's a sample | | ||
| --- | --- | --- | | ||
| 1. | Conversational bot using Bot Framework SDK | - [Bot app with Node.js](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/bot-conversation/nodejs) <br> - [Bot app with C#](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/bot-conversation/csharp) <br> - [Bot app with Python](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/bot-conversation/python) | | ||
| 1. | Conversational bot | - [Bot app with Node.js](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/bot-conversation/nodejs) <br> - [Bot app with C#](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/bot-conversation/csharp) <br> - [Bot app with Python](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/bot-conversation/python) | | ||
| 2. | Conversational bot using Agents Toolkit | [Create Teams conversation bot](how-to/conversations/channel-and-group-conversations.md) | | ||
|
||
### Build an AI-powered Teams bot app | ||
|
@@ -48,8 +48,8 @@ You can build a new custom engine agent or elevate your existing conventional bo | |
| --- | --- | --- | | ||
| 1. | Build a custom engine agent with Teams AI library | [Teams AI library](/microsoftteams/platform/teams-ai-library/welcome) | | ||
| 2. | Upgrade a conventional bot to custom engine agent | [Upgrade bot to Custom engine agent](how-to/teams-conversational-ai/how-conversation-ai-get-started.md#upgrade-your-conventional-bot-to-custom-engine-agent) | | ||
| 3. | Elevate a conventional bot built with Bot framework adapter to use AI | [Elevate your conventional bot to use AI](how-to/teams-conversational-ai/how-conversation-ai-get-started.md#elevate-your-conventional-bot-to-use-ai) | | ||
| 4. | Migrate a bot built with Bot framework to use Teams AI Library | [Migrate your bot to use Teams AI library](how-to/teams-conversational-ai/how-conversation-ai-get-started.md#migrate-your-bot-to-use-teams-ai-library) | | ||
| 3. | Elevate a conventional bot to use AI | [Elevate your conventional bot to use AI](how-to/teams-conversational-ai/how-conversation-ai-get-started.md#elevate-your-conventional-bot-to-use-ai) | | ||
| 4. | Migrate a bot to use Teams AI Library | [Migrate your bot to use Teams AI library](how-to/teams-conversational-ai/how-conversation-ai-get-started.md#migrate-your-bot-to-use-teams-ai-library) | | ||
|
||
## Next step | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,7 +32,7 @@ The next section enables you to create a new bot or add calling capabilities to | |
|
||
To create a new bot for Teams: | ||
|
||
1. Use this link to create a new bot, `https://dev.botframework.com/bots/new`. Alternately, if you select the **Create a bot** button in the Bot Framework portal, you create your bot in Microsoft Azure, for which you must have an Azure account. | ||
1. Create a new bot in [Azure portal](https://ms.portal.azure.com/#create/Microsoft.AzureBot). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we have a link to create a new Teams agent (CEA) in any portal? @MSFTRickyCastaneda |
||
> [!NOTE] | ||
> Bot display names can't include special characters. | ||
1. Add the Teams channel. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think library == SDK in general. Library is a collection of functions and sample codes. @MSFTRickyCastaneda what do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are actively trying to rename Teams AI Library to Teams something SDK. Let's keep this as is and we will change the name later.