[4728451][Doc Improvement] rename Bot Framework SDK and TeamsFX SDK-1 #13421
Conversation
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
|
Learn Build status updates of commit 02b5094: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
SirajShaik-MSFT
changed the title
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
|
Learn Build status updates of commit 3ead9e7: ✅ Validation status: passed
For more details, please refer to the build report. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
|
Learn Build status updates of commit 4dffa02: ✅ Validation status: passed
For more details, please refer to the build report. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
SirajShaik-MSFT
requested review from
MSFTRickyCastaneda,
luywang,
summzhan and
surbhigupta12
| ### 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). |
There was a problem hiding this comment.
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.
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.
| |----------------|-----------------|--------------|----------------|----------------|----------------|----------------| | ||
| | 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.
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.
| | 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.
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?
| 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.
Do we have a link to create a new Teams agent (CEA) in any portal? @MSFTRickyCastaneda
There was a problem hiding this comment.
changes look good, addressing some comments:
- Yes this is an SDK but its being called a Library, that's incorrect. We are trying to get the name changed with MSFT Brand.
- agree on Bot -> Agent in the future.
- No URL that i know of for CEA directly. Looking into it now
3 participants
No description provided.