-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added README instructions, sample gallery metadata, telemetry, screen…
… shots
- Loading branch information
Showing
4 changed files
with
84 additions
and
41 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,56 +1,31 @@ | ||
| # Overview of the Declarative Agent template | ||
| # Overview of the Presentation declarative agent | ||
|
|
||
| This agent gives you guidance on building good slides for executive presentations. | ||
| The Presentation declarative agent demonstrates how Copilot can assist users in creating a presentation based on simple instructions. | ||
| 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. | ||
|
|
||
| ## 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. | | ||
|
|
||
| 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. | ||
|
|
||
| | File | Contents | | ||
| | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `teamsapp.yml` | This is the main Teams Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions. | | ||
|
|
||
| ## Extend the template | ||
|
|
||
| - [Add conversation starters](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=3): Conversation starters are hints that are displayed to the user to demonstrate how they can get started using the declarative agent. | ||
| - [Add web content](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=4) for the ability to search web information. | ||
| - [Add OneDrive and SharePoint content](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=5) as grounding knowledge for the agent. | ||
| - [Add Microsoft Graph connectors content](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=6) to ground agent with enterprise knowledge. | ||
| - [Add API plugins](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=7) for agent to interact with REST APIs. | ||
|
|
||
| ## Addition information and references | ||
|
|
||
| - [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-PresentationAgent" /> |
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-PresentationAgent", | ||
| "source": "pnp", | ||
| "title": "Presentation Agent for Microsoft 365 Copilot", | ||
| "shortDescription": "Declarative agent helps users prepare for presentations", | ||
| "url": "https://github.com/pnp/copilot-pro-dev-samples/tree/main/samples/da-PresentationAgent", | ||
| "downloadUrl": "https://pnp.github.io/download-partial/?url=https://github.com/pnp/copilot-pro-dev-samples/tree/main/samples/da-PresentationAgent", | ||
| "longDescription": [ | ||
| "The \"Presentation\" Declarative Agent is an open-source AI-driven tool designed to assist professionals in preparing for presentations." | ||
| ], | ||
| "creationDateTime": "2025-01-28", | ||
| "updateDateTime": "2025-01-28", | ||
| "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-PresentationAgent/assets/PresentationAgent02.png", | ||
| "alt": "Copilot agent that helps users organize presentation content" | ||
| } | ||
| ], | ||
| "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" | ||
| } | ||
| ] | ||
| } | ||
| ] |