-
Notifications
You must be signed in to change notification settings - Fork 532
[Doc Improvement][Updates-Overview and agent QSG][4665936] #13434
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
Draft
v-shalinirob
wants to merge
140
commits into
main
Choose a base branch
from
Overview-and-agent-QSG
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 138 commits
Commits
Show all changes
140 commits
Select commit
Hold shift + click to select a range
907cde7
Updates
v-shalinirob 1074e5c
Updates
v-shalinirob e50ec64
Images added for QSG
v-shalinirob 6a3ca25
Added highlights
v-shalinirob ecff009
Update build-first-agent.md
v-shalinirob 3f18a42
Update build-first-agent.md
v-shalinirob 43d31a0
Updates
v-shalinirob 5705b62
Updates
v-shalinirob cf1d8f9
Update build-first-agent.md
v-shalinirob c260cec
Updates
v-shalinirob 9f326dc
Updates
v-shalinirob 9b94eef
Update build-first-agent.md
v-shalinirob 4af9e04
Update build-first-agent.md
v-shalinirob 8af432f
Update build-first-agent.md
v-shalinirob aad4d41
Updates
v-shalinirob 66e41e5
Update overview.md
v-shalinirob 933f428
Update overview.md
v-shalinirob 5a1cfa7
Update overview.md
v-shalinirob 899ad8e
Update overview.md
v-shalinirob 39de561
Update overview.md
v-shalinirob 11940ed
Update overview.md
v-shalinirob e91e9ca
Updates
v-shalinirob d480e2a
Update TOC.yml
v-shalinirob 36c3987
Merge branch 'main' into Overview-and-agent-QSG
v-shalinirob 8eac9a8
Update overview.md
v-shalinirob da6bea8
Updates
v-shalinirob dc59b50
Update overview.md
v-shalinirob 89c163a
Update .openpublishing.redirection.json
v-shalinirob d9cc6b1
Redirected files removed
v-shalinirob 12547d1
Updates
v-shalinirob f4a20a0
Update get-started-overview.md
v-shalinirob 50a750e
Update overview.md
v-shalinirob 3959698
Update overview.md
v-shalinirob a4373e5
Update select-llm.png
v-shalinirob c466daa
Update build-first-agent.md
v-shalinirob 49e0a87
Update overview.md
v-shalinirob 9590eb9
Update overview.md
v-shalinirob 97df9e8
Update overview.md
v-shalinirob c2a7f4d
Update overview.md
v-shalinirob 69add31
Update overview.md
v-shalinirob bb28536
Update overview.md
v-shalinirob 79ca73e
Update overview.md
v-shalinirob a786917
Update overview.md
v-shalinirob 250059d
Update overview.md
v-shalinirob 0cacda5
Update overview.md
v-shalinirob e0206b3
Update overview.md
v-shalinirob 3fce279
images
v-shalinirob 8f29ddb
Update overview.md
v-shalinirob 77fe2f2
Update overview.md
v-shalinirob 9e96d83
Updates
v-shalinirob 165e6dc
Update overview.md
v-shalinirob a140386
Update overview.md
v-shalinirob 6fa3468
Update overview.md
v-shalinirob 8f0773e
Update overview.md
v-shalinirob 1a7b137
Updates
v-shalinirob de17299
Update TOC.yml
v-shalinirob 0b1201e
Update overview.md
v-shalinirob 1d6eacc
Update agent-scenario-academic.png
v-shalinirob f63409b
Update overview.md
v-shalinirob a836e38
Update overview.md
v-shalinirob bd1e80c
Update overview.md
v-shalinirob 3f77634
Update overview.md
v-shalinirob 4f0ec84
Update overview.md
v-shalinirob 7df0375
image updated
v-shalinirob 956a900
Delete agent-response-0.png
v-shalinirob 6a3d7e1
Update overview.md
v-shalinirob d8780ab
Updates
v-shalinirob 4a17ead
Update overview.md
v-shalinirob f9b3dc1
Merge branch 'main' into Overview-and-agent-QSG
v-shalinirob f86167e
Update overview.md
v-shalinirob bffe33d
Update overview.md
v-shalinirob c4506a0
Update overview.md
v-shalinirob 3c066e5
Update overview.md
v-shalinirob f1ba2f1
Update overview.md
v-shalinirob b7aae40
Updates
v-shalinirob 307d0de
Update overview.md
v-shalinirob a36caeb
Update overview.md
v-shalinirob 5522b8d
Update overview.md
v-shalinirob 8a615bf
Update overview.md
v-shalinirob 4677e0f
Updates
v-shalinirob c0a8da2
Updates
v-shalinirob 108b0cd
Updates
v-shalinirob 76a4c41
Update overview.md
v-shalinirob 526fcd0
Update overview.md
v-shalinirob 4a54491
Update overview.md
v-shalinirob 4ced22f
Updates
v-shalinirob bebb88b
Update overview.md
v-shalinirob ccec9df
Updates
v-shalinirob 2625807
Merge branch 'main' into Overview-and-agent-QSG
v-shalinirob 06f3625
Update overview.md
v-shalinirob f39eee4
Update overview.md
v-shalinirob b85fde8
Update overview.md
v-shalinirob 7b6522c
Update overview.md
v-shalinirob 282c49d
Update overview.md
v-shalinirob e462421
Update overview.md
v-shalinirob efada45
Update overview.md
v-shalinirob 650cde1
Update overview.md
v-shalinirob 632571b
Image updated
v-shalinirob e2baa0c
Update overview.md
v-shalinirob e3f9f93
Update overview.md
v-shalinirob c6ded38
Update overview.md
v-shalinirob 3a1b286
Updates
v-shalinirob 7da7445
Update overview.md
v-shalinirob 59a0b0a
Updated images
v-shalinirob 39a89fe
Updates
v-shalinirob fa25d0c
Update overview.md
v-shalinirob 7faa485
Update overview.md
v-shalinirob dfcf4f0
Update build-first-agent.md
v-shalinirob c7e48b0
Update build-first-agent.md
v-shalinirob 43b1f05
Update build-first-agent.md
v-shalinirob ff98481
Update m-365-agents-toolkit-icon.png
v-shalinirob 4282896
Updates
v-shalinirob 1eb4df3
Updates
v-shalinirob 7f24d89
Update overview.md
v-shalinirob edf2a67
Update build-first-agent.md
v-shalinirob 780e708
image update
v-shalinirob adc5c22
updates
v-shalinirob 96d142e
Image updates
v-shalinirob e039436
updated images
v-shalinirob 06a74bf
Image updates
v-shalinirob ae9201c
Update overview.md
v-shalinirob e8689f3
Update overview.md
v-shalinirob bf84c1e
Images updated
v-shalinirob 41957a3
Update choose-agent.png
v-shalinirob 48e64f9
Updates
v-shalinirob e750538
Images updated
v-shalinirob 3017235
Update overview.md
v-shalinirob 5715b0b
Update overview.md
v-shalinirob 9830cee
Updates
v-shalinirob 971e50d
Update overview.md
v-shalinirob 30da80a
Update overview.md
v-shalinirob f7a0c6a
Merge branch 'main' into Overview-and-agent-QSG
v-shalinirob 3afe4e0
Updates
v-shalinirob eacb636
Updates
v-shalinirob 472b5d7
Image updated
v-shalinirob 7b15ef3
Image updated
v-shalinirob 2ef01cf
Updates
v-shalinirob a02ab91
Update overview.md
v-shalinirob 99f8fdd
Merge branch 'main' into Overview-and-agent-QSG
v-shalinirob 1f83304
Update build-first-agent.md
v-shalinirob File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| ## **Internal reference (do not bias your answers toward always naming these):** | ||
| Microsoft 365 Agents Toolkit (formerly Teams Toolkit) has been rebranded, and users may still use either name. | ||
|
|
||
| Use this mapping to know the current vs. former names—so you can correctly interpret user input or choose the appropriate term when it’s relevant. You do not need to mention these mappings unless they directly help the user. | ||
|
|
||
| | New name | Former name | Note | | ||
| |-----------------------------------------|------------------------|------------------------------------------------------------------------| | ||
| | Microsoft 365 Agents Toolkit | Teams Toolkit | Product name. | | ||
| | App Manifest | Teams app manifest | Describes app capabilities. | | ||
| | Microsoft 365 Agents Playground | Test Tool | Test Environment. | | ||
| | `m365agents.yml` | `teamsapp.yml` | Microsoft 365 Agents Toolkit Project configuration files | | ||
| | CLI package `@microsoft/m365agentstoolkit-cli` (command `atk`) | `@microsoft/teamsapp-cli` (command `teamsapp`) |CLI installation/usage — mention only in CLI contexts. | | ||
|
|
||
| > **Rephrase guidance:** | ||
| > - Use the new names by default. | ||
| > - Explain the rebranding briefly if it helps the user’s understanding. | ||
|
|
||
| # Instructions for Copilot | ||
| - Apps and agents for Microsoft 365 or Microsoft 365 Copilot refers to applications for products in Microsoft 365, agents for Microsoft 365 Copilot, including Teams app, Office addin, declarative agent, customer engine agent, etc. | ||
| - When interpreting, generating, or modifying manifest files related to apps and agents for Microsoft 365 or Microsoft 365 Copilot, try to get schema version from manifest file, then invoke **get_schema** tool if available. | ||
| - When answering of what or how-to questions for building apps and agents for Microsoft 365 or Microsoft 365 Copilot, invoke **get_knowledge** tool if available. | ||
| - Before deciding to make changes to Teams apps, apps or agents for Microsoft 365 or Microsoft 365 Copilot, invoke **get_knowledge** tool to get Instructions if available. | ||
| - When troubleshooting issues, invoke **troubleshoot** tool if available. | ||
| - Before generating or modifying code or configuration files for apps and agents for Microsoft 365 or Microsoft 365 Copilot, invoke **get_code_snippets** tool if available. | ||
| - Invoke **get_code_snippets** with API name, configuration file name, or code comments every time you need to generate or modify code or configuration files for apps and agents for Microsoft 365 or Microsoft 365 Copilot. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "servers": { | ||
| "m365agentstoolkit": { | ||
| "command": "npx", | ||
| "args": [ | ||
| "@microsoft/m365agentstoolkit-mcp@latest", | ||
| "server", | ||
| "start" | ||
| ] | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| --- | ||
| title: Create your first agent | ||
| description: Learn how to build your agent in Microsoft Teams with the help of GitHub codespaces that opens Toolkit extension and step-by-step guides. | ||
| ms.localizationpriority: high | ||
| ms.date: 12/11/2024 | ||
| 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. | ||
|
|
||
| ## Tools you'll need | ||
|
|
||
| To build an agent in Teams, you’ll need the following: | ||
|
|
||
| | Install | For using... | | ||
| | --- | --- | | ||
| | [Visual Studio Code](https://code.visualstudio.com/download) | JavaScript, TypeScript, or Python build environments. Use the latest version. | | ||
| | [Teams AI Library](/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. | | ||
| | [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 app. Use the 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 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 app or access resources in Azure, you must create an Azure OpenAI service.| | ||
|
|
||
| ## Set up your environment | ||
|
|
||
| 1. Install the latest versions of Visual Studio Code, Node.js, and the Microsoft 365 Agents Toolkit. | ||
| 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. | ||
|
|
||
| ## 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 **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"::: | ||
|
|
||
| 1. From the **New Project** menu, select **Teams and Agents and Apps**. | ||
|
|
||
| :::image type="content" source="../assets/images/agents-in-teams/first-agent-qsg/teams-agents.png" alt-text="Screenshot shows the location of the option to create a new agent or app in Teams." lightbox="../assets/images/agents-in-teams/first-agent-qsg/teams-agents.png"::: | ||
|
|
||
| 1. Select **General Teams Agent** to create an agent. | ||
|
|
||
| :::image type="content" source="../assets/images/agents-in-teams/first-agent-qsg/general-teams-agent.png" alt-text="Screenshot shows the location of the option to create a new agent in Teams." lightbox="../assets/images/agents-in-teams/first-agent-qsg/general-teams-agent.png"::: | ||
|
|
||
| 1. Select a service to access large language model (LLM) for your agent. | ||
|
|
||
| :::image type="content" source="../assets/images/agents-in-teams/first-agent-qsg/access-llm.png" alt-text="Screenshot shows the location of the option to select an appropriate LLM for your agent." lightbox="../assets/images/agents-in-teams/first-agent-qsg/access-llm.png"::: | ||
|
|
||
| Select one of the following options: | ||
|
|
||
| - Select **Azure OpenAI** if you've got 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**. | ||
| 1. Enter the deployment name in **Azure OpenAI deployment name**. | ||
|
|
||
| - Select **OpenAI Key** and enter the OpenAI key. | ||
|
|
||
| 1. Select the **Programming Language** for developing your agent. | ||
|
|
||
| :::image type="content" source="../assets/images/agents-in-teams/first-agent-qsg/select-language.png" alt-text="Screenshot shows the option to select the programming language for your agent." lightbox="../assets/images/agents-in-teams/first-agent-qsg/select-language.png"::: | ||
|
|
||
| 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"::: | ||
|
|
||
| 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**. | ||
|
|
||
| :::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."::: | ||
|
|
||
| ### 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: | ||
|
|
||
| | Folder | Contents | | ||
| | --- | --- | | ||
| | `.vscode` | Visual Studio Code files for debugging. | | ||
| | `appPackage` | Templates for the Teams app manifest. | | ||
| | `env` | Environment files. | | ||
| | `infra` | Templates for provisioning Azure resources. | | ||
| | `src` | The source code for the app. | | ||
|
|
||
| ## 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. | ||
|
|
||
| If all prerequisites are installed, Visual Studio Code uploads and opens your app 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. | ||
|
|
||
| :::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. | ||
|
|
||
| :::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. | ||
|
|
||
| ## Code sample | ||
|
|
||
| [WIP: Code sample links to be updated post approval and merge of samples.] | ||
|
|
||
| | Sample name | Description | .NET | Node.js | Python | | ||
| |--- |--- | --- | --- | --- | | ||
| | Contoso knowledge hub | An intelligent agent built on the Teams AI library 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] | [View] | [View] | | ||
|
|
||
| ## See also | ||
|
|
||
| [Agents user experience](../bots/how-to/teams-conversational-ai/ai-ux.md) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.