-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/jthake/copilot-pro-dev-samples
- Loading branch information
Showing
5 changed files
with
83 additions
and
38 deletions.
There are no files selected for viewing
This file contains 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 |
|---|---|---|
| @@ -1,51 +1,32 @@ | ||
| # Overview of the Docfinder declarative agent | ||
| The docfinder declarative agent demonstrates how you users can easily discover documents in SHarePoint and OneDrive based on those created, modified or viewed by them. As a agent builder, it illustrates how you can use instructions to steer Copilot to help the user. Take a look at the [instructions file](appPackage/instruction.txt) to see more. | ||
| The docfinder declarative agent demonstrates how you users can easily discover documents in SharePoint and OneDrive based on those created, modified or viewed by them. As a agent builder, it illustrates how you can use instructions to steer Copilot to help the user. Take a look at the [instructions file](appPackage/instruction.txt) to see more. | ||
|
|
||
| ## Build a basic declarative agent | ||
|  | ||
|
|
||
| With the declarative agent, you can build a custom version of Copilot that can be used for specific scenarios, such as for specialized knowledge, implementing specific processes, or simply to save time by reusing a set of AI prompts. For example, a grocery shopping Copilot declarative agent can be used to create a grocery list based on a meal plan that you send to Copilot. | ||
|
|
||
| ## Get started with the template | ||
| ## Minimal path to awesome | ||
|
|
||
| > **Prerequisites** | ||
| > | ||
| > To run this app template in your local dev machine, you will need: | ||
| > To run this app you will need: | ||
| > | ||
| > - [Node.js](https://nodejs.org/), supported versions: 18, 20 | ||
| > - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts). | ||
| > - [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Teams Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli) | ||
| > - A [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) with permission to sideload Teams applications. | ||
| > - [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher | ||
| > - [Microsoft 365 Copilot license](https://learn.microsoft.com/microsoft-365-copilot/extensibility/prerequisites#prerequisites) | ||
|  | ||
|
|
||
| 1. First, select the Teams Toolkit icon on the left in the VS Code toolbar. | ||
| 2. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't already. | ||
| 3. Create Teams app by clicking `Provision` in "Lifecycle" section. | ||
| 4. Select `Preview in Copilot (Edge)` or `Preview in Copilot (Chrome)` from the launch configuration dropdown. | ||
| 5. Once the Copilot app is loaded in the browser, click on the "…" menu and select "Copilot chats". You will see your declarative agent on the right rail. Clicking on it will change the experience to showcase the logo and name of your declarative agent. | ||
| 2. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't already. Ensure that both "Custom App Upload Enabled" and "Copilot Access Enabled" have green checkmarks | ||
| 3. Create and provision the Teams app by clicking `Provision` in "Lifecycle" section. | ||
| 4. Select the "Run and Debug" icon in the left sidebar, and then select `Preview in Copilot (Edge)` or `Preview in Copilot (Chrome)` from the launch configuration dropdown. | ||
| 5. Once the Copilot app is loaded in the browser, click on the "…" menu and select "Copilot agents". You will see your declarative agent on the right rail. Clicking on it will change the experience to showcase the logo and name of the declarative agent. | ||
| 6. Ask a question to your declarative agent and it should respond based on the instructions provided. | ||
|
|
||
| ## What's included in the template | ||
|
|
||
| | Folder | Contents | | ||
| | ------------ | ---------------------------------------------------------------------------------------- | | ||
| | `.vscode` | VSCode files for debugging | | ||
| | `appPackage` | Templates for the Teams application manifest, the GPT manifest and the API specification | | ||
| | `env` | Environment files | | ||
|
|
||
| The following files can be customized and demonstrate an example implementation to get you started. | ||
|
|
||
| | File | Contents | | ||
| | ---------------------------------- | ---------------------------------------------------------------------------- | | ||
| | `appPackage/declarativeAgent.json` | Define the behaviour and configurations of the declarative agent. | | ||
| | `appPackage/manifest.json` | Teams application manifest that defines metadata for your declarative agent. | | ||
| ## Addition information and references | ||
|
|
||
| The following are Teams Toolkit specific project files. You can [visit a complete guide on Github](https://github.com/OfficeDev/TeamsFx/wiki/Teams-Toolkit-Visual-Studio-Code-v5-Guide#overview) to understand how Teams Toolkit works. | ||
| - [Declarative agents for Microsoft 365](https://aka.ms/teams-toolkit-declarative-agent) | ||
|
|
||
| | File | Contents | | ||
| | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `teamsapp.yml` | This is the main Teams Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions. | | ||
| Please check out the author's YouTube short where he explains and demos the solution | ||
|
|
||
| ## Addition information and references | ||
| [](https://www.youtube.com/shorts/3eL6FlSYE48) | ||
|
|
||
| - [Declarative agents for Microsoft 365](https://aka.ms/teams-toolkit-declarative-agent) | ||
| <img src="https://m365-visitor-stats.azurewebsites.net/copilot-pro-dev-samples/samples/da-docfinder" /> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains 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,68 @@ | ||
| [ | ||
| { | ||
| "name": "pnp-copilot-pro-dev-da-docfinder", | ||
| "source": "pnp", | ||
| "title": "Career Coach Declarative Agent for Microsoft 365 Copilot Sample", | ||
| "shortDescription": "First Party Declarative Agent Career Coach shared as a sample", | ||
| "url": "https://github.com/pnp/copilot-pro-dev-samples/tree/main/samples/da-DocFinder", | ||
| "downloadUrl": "https://pnp.github.io/download-partial/?url=https://github.com/pnp/copilot-pro-dev-samples/tree/main/samples/da-docfinder", | ||
| "longDescription": [ | ||
| "The \"Career Coach\" Declarative Agent is an open-source AI-driven tool designed to assist professionals in their career development. This agent provides personalized suggestions and actionable plans to help users learn and grow in their careers. By leveraging data such as the user's current role, skills, and career aspirations, the Career Coach offers tailored advice on skill development, learning opportunities, and career transitions. It maintains a professional and supportive tone, ensuring that interactions are contextual and relevant. The agent integrates with OneDrive, SharePoint, and Graph Connectors to enhance its capabilities. Key features include creating detailed career development plans, performing skill gap analyses, recommending learning resources, and offering networking strategies. This open-source project aims to empower individuals to achieve their career goals through structured guidance and support. With the declarative agent, you can build a custom version of Copilot that can be used for specific scenarios, such as for specialized knowledge, implementing specific processes, or simply to save time by reusing a set of AI prompts. For example, a grocery shopping Copilot declarative agent can be used to create a grocery list based on a meal plan that you send to Copilot. To run this app template in your local dev machine, you will need Node.js (supported versions: 16, 18), a Microsoft 365 account for development, Teams Toolkit Visual Studio Code Extension version 5.0.0 and higher or Teams Toolkit CLI, and a Microsoft 365 Copilot license. First, select the Teams Toolkit icon on the left in the VS Code toolbar. In the Account section, sign in with your Microsoft 365 account if you haven't already. Create Teams app by clicking `Provision` in \"Lifecycle\" section. Select `Preview in Copilot (Edge)` or `Preview" | ||
| ], | ||
| "creationDateTime": "2024-10-04", | ||
| "updateDateTime": "2024-10-04", | ||
| "products": [ | ||
| "Microsoft 365 Copilot", "Teams Toolkit" | ||
| ], | ||
| "metadata": [ | ||
| { | ||
| "key": "PLATFORM", | ||
| "value": "Copilot" | ||
| }, | ||
| { | ||
| "key": "LANGUAGE", | ||
| "value": "JSON" | ||
| }, | ||
| { | ||
| "key": "API-PLUGIN", | ||
| "value": "No" | ||
| }, | ||
| { | ||
| "key": "GRAPH-CONNECTOR", | ||
| "value": "No" | ||
| } | ||
| ], | ||
| "thumbnails": [ | ||
| { | ||
| "type": "image", | ||
| "order": 100, | ||
| "url": "https://raw.githubusercontent.com/pnp/copilot-pro-dev-samples/refs/heads/main/samples/da-docFinder/assets/JeremyDocFinder.png", | ||
| "alt": "Copilot agent that finds documents you have worked on" | ||
| } | ||
| ], | ||
| "authors": [ | ||
| { | ||
| "gitHubAccount": "jthake", | ||
| "pictureUrl": "https://github.com/jthake.png", | ||
| "name": "Jeremy Thake" | ||
| } | ||
| ], | ||
| "references": [ | ||
| { | ||
| "name": "Microsoft 365 Copilot extensibility", | ||
| "description": "Learn more about what Microsoft 365 Copilot and how you can extend it.", | ||
| "url": "https://learn.microsoft.com/microsoft-365-copilot/extensibility/" | ||
| }, | ||
| { | ||
| "name": "Declarative agents for Microsoft 365 Copilot overview", | ||
| "description": "Learn more about what declarative agents for Microsoft 365 Copilot are.", | ||
| "url": "https://learn.microsoft.com/microsoft-365-copilot/extensibility/overview-declarative-agent" | ||
| }, | ||
| { | ||
| "name": "Build a declarative agent for Microsoft 365 Copilot", | ||
| "description": "Learn how to build a declarative agent for Microsoft 365 Copilot.", | ||
| "url": "https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents" | ||
| } | ||
| ] | ||
| } | ||
| ] |
This file contains 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