docs: update README.md

OfficeDev · Apr 28, 2024 · 0bc71b2 · 0bc71b2
1 parent 8d76945
commit 0bc71b2
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 41 deletions.
diff --git a/templates/common/copilot-gpt-basic/README.md b/templates/common/copilot-gpt-basic/README.md
@@ -1,8 +1,8 @@
-# Overview of the Copilot GPT template
+# Overview of the Basic Declarative Copilot template
 
-## Build a Copilot GPT from OpenAPI description document
+## Build a basic declarative copilot
 
-With Copilot GPT, 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 GPT can be used to create a grocery list based on a meal plan that you send to the Copilot GPT. 
+With the declative copilot, 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 GPT can be used to create a grocery list based on a meal plan that you send to the Copilot GPT.
 
 ## Get started with the template
 
@@ -19,22 +19,30 @@ With Copilot GPT, you can build a custom version of Copilot that can be used for
 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. Open the `Copilot` app and send a prompt to trigger your GPT.
+5. Once the Copilot app is loaded in the browser, click on the "…" menu and select "Copilot chats". You will see your declarative copilot on the right rail. Clicking on it will change the experience to showcase the logo and name of your declarative copilot.
+6. Ask a question to your declarative copilot and it should respond based on the instructions provided.
 
 ## What's included in the template
 
-| Folder       | Contents                                     |
-| ------------ | -------------------------------------------- |
-| `.vscode`    | VSCode files for debugging                   |
+| Folder       | Contents                                                                                 |
+| ------------ | ---------------------------------------------------------------------------------------- |
+| `.vscode`    | VSCode files for debugging                                                               |
 | `appPackage` | Templates for the Teams application manifest, the GPT manifest and the API specification |
-| `env`        | Environment files                            |
+| `env`        | Environment files                                                                        |
+
+The following files can be customized and demonstrate an example implementation to get you started.
+
+| File                                 | Contents                                                                       |
+| ------------------------------------ | ------------------------------------------------------------------------------ |
+| `appPackage/declarativeCopilot.json` | Define the behaviour and configurations of the declarative copilot.            |
+| `appPackage/manifest.json`           | Teams application manifest that defines metadata for your declarative copilot. |
 
 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. |
+| File           | Contents                                                                                                                                  |
+| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
+| `teamsapp.yml` | This is the main Teams Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions. |
 
 ## Addition information and references
 
-- [Extend Microsoft Copilot for Microsoft 365](https://aka.ms/teamsfx-copilot-plugin)
+- [Extend Microsoft Copilot for Microsoft 365](https://aka.ms/teamsfx-copilot-plugin)
diff --git a/templates/common/copilot-gpt-basic/appPackage/manifest.json.tpl b/templates/common/copilot-gpt-basic/appPackage/manifest.json.tpl
@@ -28,9 +28,11 @@
         "identity",
         "messageTeamMembers"
     ],
-    "copilotGpts" [
-        "id": "declarativeCopilot",
-        "file": "declarativeCopilot.json"
+    "copilotGpts": [
+        {
+            "id": "declarativeCopilot",
+            "file": "declarativeCopilot.json"
+        }
     ],
     "validDomains": []
 }
diff --git a/templates/js/copilot-gpt-from-scratch-plugin/README.md b/templates/js/copilot-gpt-from-scratch-plugin/README.md
@@ -1,8 +1,8 @@
-# Overview of the Copilot GPT template
+# Overview of the Declarative Copilot template
 
-## Build a Copilot GPT from a new API with Azure Functions
+## Build a Declarative Copilot from a new API with Azure Functions
 
-With Copilot GPT, 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 GPT can be used to create a grocery list based on a meal plan that you send to the Copilot GPT. 
+With Declarative Copilot, 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 Declarative Copilot can be used to create a grocery list based on a meal plan that you send to the Declarative Copilot.
 
 ## Get started with the template
 
@@ -18,11 +18,12 @@ With Copilot GPT, you can build a custom version of Copilot that can be used for
 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. Select `Debug in Copilot (Edge)` or `Debug in Copilot (Chrome)` from the launch configuration dropdown.
-4. Send a message to Copilot to find a repair record.
+4. Once the Copilot app is loaded in the browser, click on the "…" menu and select "Copilot chats". You will see your declarative copilot on the right rail. Clicking on it will change the experience to showcase the logo and name of your declarative copilot.
+5. Ask your declarative copilot a question, such as "Show repair records assigned to Karin Blair". It will respond with the relevant repair records.
 
 ## What's included in the template
 
-| Folder       | Contents                                                                                                    |
+| Folder       | Contents                                                                                    |
 | ------------ | ------------------------------------------------------------------------------------------- |
 | `.vscode`    | VSCode files for debugging                                                                  |
 | `appPackage` | Templates for the Teams application manifest, the plugin manifest and the API specification |
@@ -32,14 +33,14 @@ With Copilot GPT, you can build a custom version of Copilot that can be used for
 
 The following files can be customized and demonstrate an example implementation to get you started.
 
-| File                                         | Contents                                                                                          |
-| -------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `src/functions/repair.js`                    | The main file of a function in Azure Functions.                                                   |
-| `src/repairsData.json`                       | The data source for the repair API.                                                               |
-| `appPackage/apiSpecificationFile/repair.yml` | A file that describes the structure and behavior of the repair API.                               |
-| `appPackage/manifest.json`                   | Teams application manifest that defines metadata for your plugin inside Microsoft Teams.          |
-| `appPackage/ai-plugin.json`                  | The manifest file for your Copilot GPT that contains information for your API and used by LLM. |
-| `appPackage/repair-gpt.json`                 | The manifest file for your Copilot GPT that contains definitions for your GPT.                    |
+| File                                         | Contents                                                                                               |
+| -------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
+| `src/functions/repair.js`                    | The main file of a function in Azure Functions.                                                        |
+| `src/repairsData.json`                       | The data source for the repair API.                                                                    |
+| `appPackage/apiSpecificationFile/repair.yml` | A file that describes the structure and behavior of the repair API.                                    |
+| `appPackage/manifest.json`                   | Teams application manifest that defines metadata for your copilot plugin and declarative copilot.      |
+| `appPackage/ai-plugin.json`                  | The manifest file for your Declarative Copilot that contains information for your API and used by LLM. |
+| `appPackage/repairDeclarativeCopilot.json`   | Define the behaviour and configurations of the declarative copilot.                                    |
 
 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.
 
@@ -50,4 +51,4 @@ The following are Teams Toolkit specific project files. You can [visit a complet
 
 ## Addition information and references
 
-- [Extend Microsoft Copilot for Microsoft 365](https://aka.ms/teamsfx-copilot-plugin)
+- [Extend Microsoft Copilot for Microsoft 365](https://aka.ms/teamsfx-copilot-plugin)
diff --git a/templates/ts/copilot-gpt-from-scratch-plugin/README.md b/templates/ts/copilot-gpt-from-scratch-plugin/README.md
@@ -1,8 +1,8 @@
-# Overview of the Copilot GPT template
+# Overview of the Declarative Copilot template
 
-## Build a Copilot GPT from a new API with Azure Functions
+## Build a Declarative Copilot from a new API with Azure Functions
 
-With Copilot GPT, 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 GPT can be used to create a grocery list based on a meal plan that you send to the Copilot GPT.
+With Declarative Copilot, 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 Declarative Copilot can be used to create a grocery list based on a meal plan that you send to the Declarative Copilot.
 
 ## Get started with the template
 
@@ -18,7 +18,8 @@ With Copilot GPT, you can build a custom version of Copilot that can be used for
 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. Select `Debug in Copilot (Edge)` or `Debug in Copilot (Chrome)` from the launch configuration dropdown.
-4. Send a message to Copilot to find a repair record.
+4. Once the Copilot app is loaded in the browser, click on the "…" menu and select "Copilot chats". You will see your declarative copilot on the right rail. Clicking on it will change the experience to showcase the logo and name of your declarative copilot.
+5. Ask your declarative copilot a question, such as "Show repair records assigned to Karin Blair". It will respond with the relevant repair records.
 
 ## What's included in the template
 
@@ -32,14 +33,14 @@ With Copilot GPT, you can build a custom version of Copilot that can be used for
 
 The following files can be customized and demonstrate an example implementation to get you started.
 
-| File                                         | Contents                                                                                          |
-| -------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `src/functions/repair.ts`                    | The main file of a function in Azure Functions.                                                   |
-| `src/repairsData.json`                       | The data source for the repair API.                                                               |
-| `appPackage/apiSpecificationFile/repair.yml` | A file that describes the structure and behavior of the repair API.                               |
-| `appPackage/manifest.json`                   | Teams application manifest that defines metadata for your plugin inside Microsoft Teams.          |
-| `appPackage/ai-plugin.json`                  | The manifest file for your Copilot Plugin that contains information for your API and used by LLM. |
-| `appPackage/repair-gpt.json`                 | The manifest file for your Copilot GPT that contains definitions for your GPT.                    |
+| File                                         | Contents                                                                                               |
+| -------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
+| `src/functions/repair.ts`                    | The main file of a function in Azure Functions.                                                        |
+| `src/repairsData.json`                       | The data source for the repair API.                                                                    |
+| `appPackage/apiSpecificationFile/repair.yml` | A file that describes the structure and behavior of the repair API.                                    |
+| `appPackage/manifest.json`                   | Teams application manifest that defines metadata for your copilot plugin and declarative copilot.      |
+| `appPackage/ai-plugin.json`                  | The manifest file for your Declarative Copilot that contains information for your API and used by LLM. |
+| `appPackage/repairDeclarativeCopilot.json`   | Define the behaviour and configurations of the declarative copilot.                                    |
 
 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.