-
Notifications
You must be signed in to change notification settings - Fork 532
[Dev-Docs AI Improvement]: Build your first agent #13650
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 |
|---|---|---|
|
|
@@ -8,25 +8,25 @@ ms.topic: reference | |
|
|
||
| # Build your first agent | ||
|
|
||
| Agents use AI to automate and execute business processes, working alongside or on behalf of a person, team, or organization. Agents range from simple prompt-and-response agents to more advanced, fully autonomous agents. | ||
| Agents utilize AI to automate and execute business processes, working alongside or on behalf of a person, team, or organization. Agents range from simple prompt-and-response implementations to more advanced, fully autonomous solutions. | ||
|
|
||
| ## Tools you'll need | ||
|
|
||
| To build an agent in Teams, you’ll need the following: | ||
| To build an agent in Teams, use the following: | ||
|
|
||
| | Install | For using... | | ||
| | --- | --- | | ||
| | [Visual Studio Code](https://code.visualstudio.com/download) | JavaScript, TypeScript, or Python build environments. Use the latest version. | | ||
| | [Teams SDK](/microsoftteams/platform/teams-ai-library/teams/overview) | A simplified SDK for building intelligent agents. Now GA for JavaScript and C#, and in public preview for Python. | | ||
|
Collaborator
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. A simplified is correct |
||
| | [Microsoft 365 Agents Toolkit](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension) | Microsoft Visual Studio Code extension that creates a project scaffolding for your agent. Use the latest version.| | ||
|
Collaborator
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. We should use the article the here |
||
| | [Visual Studio Code](https://code.visualstudio.com/download) | JavaScript, TypeScript, or Python build environments. Use latest version. | | ||
| | [Teams SDK](/microsoftteams/platform/teams-ai-library/teams/overview) | Simplified SDK for building intelligent agents. Now GA for JavaScript and C#, and in public preview for Python. | | ||
| | [Microsoft 365 Agents Toolkit](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension) | Microsoft Visual Studio Code extension that creates project scaffolding for your agent. Use latest version.| | ||
| | [Node.js](https://nodejs.org/en/download/) | Back-end JavaScript runtime environment. For more information, see [Node.js version compatibility table for project type](~/toolkit/build-environments.md#nodejs-version-compatibility-table-for-project-type).| | ||
| | [Microsoft Teams](https://www.microsoft.com/microsoft-teams/download-app) | Microsoft Teams to collaborate with everyone you work with through agents and apps for chat, meetings, and calls all in one place.| | ||
| | [Azure OpenAI](https://oai.azure.com/portal)| First create your OpenAI API key to use OpenAI's Generative Pretrained Transformer (GPT). If you want to host your agent or access resources in Azure, you must create an Azure OpenAI service.| | ||
|
Collaborator
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. We should use the article an here. |
||
| | [Microsoft Teams](https://www.microsoft.com/microsoft-teams/download-app) | Microsoft Teams for collaborating with everyone via agents and apps for chat, meetings, and calls in one place.| | ||
| | [Azure OpenAI](https://oai.azure.com/portal)| First create your OpenAI API key to use OpenAI's Generative Pretrained Transformer (GPT). To host your agent or access resources in Azure, you must create Azure OpenAI service.| | ||
|
|
||
| ## Set up your environment | ||
|
|
||
| 1. Install the latest versions of Visual Studio Code, Node.js, and the Microsoft 365 Agents Toolkit. | ||
|
Collaborator
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. The should be used here. "Install the latest versions. |
||
| 1. If you want to use Azure OpenAI service to access large language model (LLM) for your agent, create an Azure OpenAI service on the [Azure portal](https://ms.portal.azure.com/#home) and get your API key. | ||
|
Collaborator
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. For plain English we can say "If you want to use" |
||
| 1. Install latest versions of Visual Studio Code, Node.js, and Microsoft 365 Agents Toolkit. | ||
| 1. If you want to integrate Azure OpenAI service to access large language model (LLM) for your agent, create an Azure OpenAI service on the [Azure portal](https://ms.portal.azure.com/#home) and obtain your API key. | ||
|
|
||
| For more information about setting up Azure OpenAI services, see: | ||
|
|
||
|
|
@@ -36,7 +36,7 @@ For more information about setting up Azure OpenAI services, see: | |
| ## Create an agent using Microsoft 365 Agents Toolkit | ||
|
|
||
| 1. Open Visual Studio Code. | ||
| 1. Select the Microsoft 365 Agents Toolkit :::image type="icon" source="~/assets/icons/m-365-agents-toolkit-icon.png" border="false"::: icon in the Visual Studio Code **Activity Bar**. | ||
| 1. Select Microsoft 365 Agents Toolkit :::image type="icon" source="~/assets/icons/m-365-agents-toolkit-icon.png" border="false"::: icon in Visual Studio Code **Activity Bar**. | ||
| 1. Select **Create a New Agent/App**. | ||
|
|
||
| :::image type="content" source="../assets/images/agents-in-teams/first-agent-qsg/create-new-agent.png" alt-text="Screenshot shows the location of the option to create a new agent using Microsoft 365 Agents Toolkit sidebar." lightbox="../assets/images/agents-in-teams/first-agent-qsg/create-new-agent.png"::: | ||
|
|
@@ -55,7 +55,7 @@ For more information about setting up Azure OpenAI services, see: | |
|
|
||
| Select one of the following options: | ||
|
|
||
| - Select **Azure OpenAI** if you've got the OpenAI key from Azure. Following this, you must: | ||
| - Select **Azure OpenAI** if you've obtained the OpenAI key from Azure. Following this, you must: | ||
|
|
||
| 1. Enter Azure OpenAI key in **Azure OpenAI service key**. | ||
| 1. Enter the endpoint in **Azure OpenAI service endpoint**. | ||
|
|
@@ -69,50 +69,50 @@ For more information about setting up Azure OpenAI services, see: | |
|
|
||
| 1. Select the **Default folder** as the **Workspace Folder** for your agent project. | ||
|
|
||
| :::image type="content" source="../assets/images/agents-in-teams/first-agent-qsg/select-workspace.png" alt-text="Screenshot shows the field to select the workspace forlder for your agent project." lightbox="../assets/images/agents-in-teams/first-agent-qsg/select-workspace.png"::: | ||
| :::image type="content" source="../assets/images/agents-in-teams/first-agent-qsg/select-workspace.png" alt-text="Screenshot shows the field to select the workspace folder for your agent project." lightbox="../assets/images/agents-in-teams/first-agent-qsg/select-workspace.png"::: | ||
|
|
||
| 1. Enter the agent name and then select **Enter**. | ||
|
|
||
| :::image type="content" source="../assets/images/agents-in-teams/first-agent-qsg/add-agent-name.png" alt-text="Screenshot shows the field to add the agent name." lightbox="../assets/images/agents-in-teams/first-agent-qsg/add-agent-name.png"::: | ||
|
|
||
| The toolkit displays a message that the agent has been successfully created. You can also provision the agent at this time or later. If the toolkit displays a message to confirm if you trust the author, select **Yes, I trust the authors**. | ||
| The toolkit displays a message indicating successful agent creation. You can provision the agent immediately or later. If the toolkit asks to confirm trust for the author, select **Yes, I trust the authors**. | ||
|
Collaborator
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. The first sentence has "displays the message" and also the second one. But only the second one is changed. |
||
|
|
||
| :::image type="content" source="../assets/images/agents-in-teams/first-agent-qsg/trust-author.png" alt-text="Screenshows the message for confirming if you trust the authors of the agent."::: | ||
| :::image type="content" source="../assets/images/agents-in-teams/first-agent-qsg/trust-author.png" alt-text="Screenshot shows the message for confirming trust in the agent authors."::: | ||
|
|
||
| ### Take a tour of the agent source code | ||
|
|
||
| Microsoft 365 Agents Toolkit creates your agent project and scaffolds the project workspace. Here's a look at the folder structure: | ||
| Microsoft 365 Agents Toolkit creates your agent project and scaffolds the project workspace. Review the folder structure: | ||
|
|
||
| | Folder | Contents | | ||
| | --- | --- | | ||
| | `.vscode` | Visual Studio Code files for debugging. | | ||
| | `appPackage` | Templates for the Teams manifest. | | ||
| | `env` | Environment files. | | ||
| | `infra` | Templates for provisioning Azure resources. | | ||
| | `src` | The source code for the project. | | ||
| | `src` | Source code for the project. | | ||
|
Collaborator
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. These descriptions we usually copy from the VS code. So not sure if we should change them |
||
|
|
||
| ## Run and use your agent in Teams | ||
|
|
||
| 1. Open your agent project in Visual Studio Code. | ||
| 1. Select **Run** > **Start Debugging**, or alternatively, select the **F5** key. | ||
| 1. Select **Run** > **Start Debugging**, or press **F5**. | ||
|
|
||
| If all prerequisites are installed, Visual Studio Code uploads and opens your agent in Microsoft Teams. | ||
|
|
||
| :::image type="content" source="../assets/images/agents-in-teams/first-agent-qsg/run-agent-in-teams.png" alt-text="Screenshot shows the agent opened in Microsoft Teams." lightbox="../assets/images/agents-in-teams/first-agent-qsg/run-agent-in-teams.png"::: | ||
|
|
||
| 1. To use your agent, select one of the prompts shown by the agent. | ||
| 1. To use your agent, select one of the prompts displayed by the agent. | ||
|
|
||
| :::image type="content" source="../assets/images/agents-in-teams/first-agent-qsg/select-agent-prompt.png" alt-text="Screenshot shows how to select a prompt from the agent." lightbox="../assets/images/agents-in-teams/first-agent-qsg/select-agent-prompt.png"::: | ||
|
|
||
| When you select the prompt, it shows up in the comment box, and you can select the **Send** icon. The agent responds to the prompt. | ||
| When you select the prompt, it appears in the comment box. Select the **Send** icon to receive the agent's response. | ||
|
Collaborator
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. Select send icon to get the agent's response. Also, don't know it is an icon or button |
||
|
|
||
| :::image type="content" source="../assets/images/agents-in-teams/first-agent-qsg/agent-response.png" alt-text="Screenshot shows the agent response to the user prompt." lightbox="../assets/images/agents-in-teams/first-agent-qsg/agent-response.png"::: | ||
|
|
||
| Congratulations! You've created and ran your first agent in Teams. | ||
|
|
||
| ## Choose your programming language | ||
|
|
||
| Teams SDK is available for JavaScript, C#, and Python (dev preview). It provides a simplified SDK, support for Model Context Protocol (MCP), Agent-to-Agent communication (A2A), and streamlined tools to enable developers to build intelligent agents for Teams. | ||
| Teams SDK supports JavaScript, C#, and Python (dev preview). It provides a simplified SDK, support for Model Context Protocol (MCP), Agent-to-Agent communication (A2A), and streamlined tools to develop intelligent agents for Teams. | ||
|
|
||
| :::row::: | ||
| :::column::: | ||
|
|
@@ -144,8 +144,8 @@ Teams SDK is available for JavaScript, C#, and Python (dev preview). It provides | |
|
|
||
| | Sample name | Description | .NET | Node.js | Python | | ||
| |--- |--- | --- | --- | --- | | ||
| | Contoso knowledge hub | An intelligent agent built on the Teams SDK that is designed to empower students in their academic and career journeys. The agent offers personalized support for course selection, study strategies, career development planning, and academic roadmap creation. | [View](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/agent-knowledge-hub/csharp) | [View](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/agent-knowledge-hub/nodejs) | [View](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/agent-knowledge-hub/python) | | ||
| | Contoso knowledge hub | An intelligent agent built on Teams SDK designed to empower students in their academic and career journeys. The agent offers personalized support for course selection, study strategies, career development planning, and academic roadmap creation. | [View](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/agent-knowledge-hub/csharp) | [View](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/agent-knowledge-hub/nodejs) | [View](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/agent-knowledge-hub/python) | | ||
|
|
||
| ## See also | ||
|
|
||
| [Agents user experience](../bots/how-to/teams-conversational-ai/ai-ux.md) | ||
| [Agents user experience](../bots/how-to/teams-conversational-ai/ai-ux.md) | ||
|
Collaborator
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. I don't find any change here. |
||
Uh oh!
There was an error while loading. Please reload this page.
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.
It should be "Agents use".
It should be agents not implementations.
It should be agents not solutions.