Skip to content

Commit

Permalink
refactor: template update
Browse files Browse the repository at this point in the history
  • Loading branch information
yuqizhou77 committed Sep 13, 2024
1 parent 4e1f147 commit b709961
Show file tree
Hide file tree
Showing 24 changed files with 83 additions and 83 deletions.
14 changes: 7 additions & 7 deletions templates/common/api-plugin-existing-api/README.md.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ When you extend Copilot for Microsoft 365, you maximize the efficiency of your a
![image](https://github.com/user-attachments/assets/1c125380-a935-4f65-a3b8-e8b9a646f3bc)
{{/DeclarativeCopilot}}
{{#DeclarativeCopilot}}
# Overview of the basic declarative copilot with API plugin template
# Overview of the basic declarative agent with API plugin template

## Build a basic declarative copilot with API plugin
## Build a basic declarative agent with API plugin

With the 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 Copilot declarative copilot can be used to create a grocery list based on a meal plan that you send to Copilot.
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.

You can extend declarative copilots using plugins to retrieve data and execute tasks on external systems. A declarative copilot can utilize multiple plugins at the same time.
You can extend declarative agents using plugins to retrieve data and execute tasks on external systems. A declarative agent can utilize multiple plugins at the same time.

![image](https://github.com/user-attachments/assets/be5bb0e0-09cc-4e57-b535-a65adadbe8aa)

Expand All @@ -50,7 +50,7 @@ You can extend declarative copilots using plugins to retrieve data and execute t
> Note: Please make sure to switch to New Teams when Teams web client has launched
{{/DeclarativeCopilot}}
{{#DeclarativeCopilot}}
4. Select your declarative Copilot from the `Copilot` app.
4. Select your declarative agent from the `Copilot` app.
5. Send a prompt.
{{/DeclarativeCopilot}}

Expand Down Expand Up @@ -92,8 +92,8 @@ The following files can be customized and demonstrate an example implementation

| 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. |
| `appPackage/declarativeCopilot.json` | Define the behaviour and configurations of the declarative agent. |
| `appPackage/manifest.json` | Teams application manifest that defines metadata for your declarative agent. |
{{/DeclarativeCopilot}}

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@
"instructions": "$[file('instruction.txt')]"
{{/FileFunction}}
{{^FileFunction}}
"instructions": "You are a declarative copilot and were created with Team Toolkit. You should start every response and answer to the user with \"Thanks for using Teams Toolkit to create your declarative copilot!\n\n\" and then answer the questions and help the user."
"instructions": "You are a declarative agent and were created with Team Toolkit. You should start every response and answer to the user with \"Thanks for using Teams Toolkit to create your declarative agent!\n\n\" and then answer the questions and help the user."
{{/FileFunction}}
}
Original file line number Diff line number Diff line change
@@ -1 +1 @@
You are a declarative copilot and were created with Team Toolkit. You should start every response and answer to the user with "Thanks for using Teams Toolkit to create your declarative copilot!\n\n" and then answer the questions and help the user.
You are a declarative agent and were created with Team Toolkit. You should start every response and answer to the user with "Thanks for using Teams Toolkit to create your declarative agent!\n\n" and then answer the questions and help the user.
14 changes: 7 additions & 7 deletions templates/common/copilot-gpt-basic/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Overview of the basic declarative copilot template
# Overview of the basic declarative agent template

## Build a basic declarative copilot
## Build a basic declarative agent

With the 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 Copilot declarative copilot can be used to create a grocery list based on a meal plan that you send to Copilot.
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

Expand All @@ -21,8 +21,8 @@ With the declarative copilot, you can build a custom version of Copilot that can
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 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.
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.
6. Ask a question to your declarative agent and it should respond based on the instructions provided.

## What's included in the template

Expand All @@ -36,8 +36,8 @@ The following files can be customized and demonstrate an example implementation

| 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. |
| `appPackage/declarativeCopilot.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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@
"instructions": "$[file('instruction.txt')]"
{{/FileFunction}}
{{^FileFunction}}
"instructions": "You are a declarative copilot and were created with Team Toolkit. You should start every response and answer to the user with \"Thanks for using Teams Toolkit to create your declarative copilot!\n\n\" and then answer the questions and help the user."
"instructions": "You are a declarative agent and were created with Team Toolkit. You should start every response and answer to the user with \"Thanks for using Teams Toolkit to create your declarative agent!\n\n\" and then answer the questions and help the user."
{{/FileFunction}}
}
Original file line number Diff line number Diff line change
@@ -1 +1 @@
You are a declarative copilot and were created with Team Toolkit. You should start every response and answer to the user with "Thanks for using Teams Toolkit to create your declarative copilot!\n\n" and then answer the questions and help the user.
You are a declarative agent and were created with Team Toolkit. You should start every response and answer to the user with "Thanks for using Teams Toolkit to create your declarative agent!\n\n" and then answer the questions and help the user.
4 changes: 2 additions & 2 deletions templates/csharp/copilot-gpt-basic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
2. Right-click the '{{NewProjectTypeName}}' project and select Teams Toolkit > Prepare Teams App Dependencies
3. If prompted, sign in with a Microsoft 365 account for the Teams organization you want to install the app to.
4. In the debug dropdown menu, select `Copilot (browser)`.
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.
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.
6. Ask a question to your declarative agent and it should respond based on the instructions provided.

## Get more info

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
"version": "v1.0",
"name": "{{appName}}",
"description": "Declarative copilot created with Teams Toolkit",
"instructions": "You are a declarative copilot and were created with Team Toolkit. You should start every response and answer to the user with \"Thanks for using Teams Toolkit to create your declarative copilot!\\n\" and then answer the questions and help the user."
"instructions": "You are a declarative agent and were created with Team Toolkit. You should start every response and answer to the user with \"Thanks for using Teams Toolkit to create your declarative agent!\\n\" and then answer the questions and help the user."
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
2. Right-click the '{{NewProjectTypeName}}' project and select Teams Toolkit > Prepare Teams App Dependencies
3. If prompted, sign in with a Microsoft 365 account for the Teams organization you want to install the app to.
4. In the debug dropdown menu, select `Copilot (browser)`.
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 your declarative copilot a question, such as "Show repair records assigned to Karin Blair". It will respond with the relevant repair records.
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.
6. Ask your declarative agent a question, such as "Show repair records assigned to Karin Blair". It will respond with the relevant repair records.

## Get more info

Expand Down
4 changes: 2 additions & 2 deletions templates/csharp/copilot-gpt-from-scratch-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
2. Right-click your project and select `Teams Toolkit > Prepare Teams App Dependencies`.
3. If prompted, sign in with a Microsoft 365 account for the Teams organization you want to install the app to.
4. In the debug dropdown menu, select `Copilot (browser)`.
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 your declarative copilot a question, such as "Show repair records assigned to Karin Blair". It will respond with the relevant repair records.
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.
6. Ask your declarative agent a question, such as "Show repair records assigned to Karin Blair". It will respond with the relevant repair records.

## Learn more

Expand Down
12 changes: 6 additions & 6 deletions templates/js/api-plugin-from-scratch-bearer/README.md.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ When you extend Copilot for Microsoft 365, you maximize the efficiency of your a
![image](https://github.com/user-attachments/assets/1c125380-a935-4f65-a3b8-e8b9a646f3bc)
{{/DeclarativeCopilot}}
{{#DeclarativeCopilot}}
# Overview of the declarative copilot with API plugin template
# Overview of the declarative agent with API plugin template

## Build a declarative copilot with an API Plugin from a new API with Azure Functions
## Build a declarative agent with an API Plugin from a new API with Azure Functions

With the 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 Copilot declarative copilot can be used to create a grocery list based on a meal plan that you send to Copilot.
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.

You can extend declarative copilots using plugins to retrieve data and execute tasks on external systems. A declarative copilot can utilize multiple plugins at the same time.
You can extend declarative agents using plugins to retrieve data and execute tasks on external systems. A declarative agent can utilize multiple plugins at the same time.
![image](https://github.com/user-attachments/assets/be5bb0e0-09cc-4e57-b535-a65adadbe8aa)
{{/DeclarativeCopilot}}

Expand All @@ -47,7 +47,7 @@ You can extend declarative copilots using plugins to retrieve data and execute t
> Note: Please make sure to switch to New Teams when Teams web client has launched
{{/DeclarativeCopilot}}
{{#DeclarativeCopilot}}
4. Select your declarative copilot from the `Copilot` app.
4. Select your declarative agent from the `Copilot` app.
5. Send a message to Copilot to find a repair record.
{{/DeclarativeCopilot}}

Expand Down Expand Up @@ -90,7 +90,7 @@ The following files can be customized and demonstrate an example implementation
| `appPackage/manifest.json` | Teams application manifest that defines metadata for your plugin inside Microsoft Teams. |
| `appPackage/ai-plugin.json` | The manifest file for your API Plugin that contains information for your API and used by LLM. |
{{#DeclarativeCopilot}}
| `appPackage/repairDeclarativeCopilot.json` | Define the behaviour and configurations of the declarative copilot. |
| `appPackage/repairDeclarativeCopilot.json` | Define the behaviour and configurations of the declarative agent. |
{{/DeclarativeCopilot}}
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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "https://aka.ms/json-schemas/copilot-extensions/vNext/declarative-copilot.schema.json",
"version": "v1.0",
"name": "{{appName}}${{APP_NAME_SUFFIX}}",
"description": "This declarative copilot helps you with finding car repair records.",
"description": "This declarative agent helps you with finding car repair records.",
{{#FileFunction}}
"instructions": "$[file('instruction.txt')]",
{{/FileFunction}}
Expand Down
12 changes: 6 additions & 6 deletions templates/js/api-plugin-from-scratch-oauth/README.md.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ When you extend Copilot for Microsoft 365, you maximize the efficiency of your a
![image](https://github.com/user-attachments/assets/1c125380-a935-4f65-a3b8-e8b9a646f3bc)
{{/DeclarativeCopilot}}
{{#DeclarativeCopilot}}
# Overview of the declarative copilot with API plugin template
# Overview of the declarative agent with API plugin template

## Build a declarative copilot with an API Plugin from a new API with Azure Functions
## Build a declarative agent with an API Plugin from a new API with Azure Functions

With the 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 Copilot declarative copilot can be used to create a grocery list based on a meal plan that you send to Copilot.
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.

You can extend declarative copilots using plugins to retrieve data and execute tasks on external systems. A declarative copilot can utilize multiple plugins at the same time.
You can extend declarative agents using plugins to retrieve data and execute tasks on external systems. A declarative agent can utilize multiple plugins at the same time.
![image](https://github.com/user-attachments/assets/be5bb0e0-09cc-4e57-b535-a65adadbe8aa)
{{/DeclarativeCopilot}}

Expand All @@ -47,7 +47,7 @@ You can extend declarative copilots using plugins to retrieve data and execute t
> Note: Please make sure to switch to New Teams when Teams web client has launched
{{/DeclarativeCopilot}}
{{#DeclarativeCopilot}}
4. Select your declarative copilot from the `Copilot` app.
4. Select your declarative agent from the `Copilot` app.
5. Send a message to Copilot to find a repair record.
{{/DeclarativeCopilot}}

Expand All @@ -73,7 +73,7 @@ The following files can be customized and demonstrate an example implementation
| `appPackage/ai-plugin.dev.json` | The manifest file for your API Plugin that contains information for your API and used by LLM. |
| `appPackage/ai-plugin.local.json` | The manifest file for your API Plugin for local execution and debugging. |
{{#DeclarativeCopilot}}
| `appPackage/repairDeclarativeCopilot.json` | Define the behaviour and configurations of the declarative copilot. |
| `appPackage/repairDeclarativeCopilot.json` | Define the behaviour and configurations of the declarative agent. |
{{/DeclarativeCopilot}}

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "https://aka.ms/json-schemas/copilot-extensions/vNext/declarative-copilot.schema.json",
"version": "v1.0",
"name": "{{appName}}${{APP_NAME_SUFFIX}}",
"description": "This declarative copilot helps you with finding car repair records.",
"description": "This declarative agent helps you with finding car repair records.",
{{#FileFunction}}
"instructions": "$[file('instruction.txt')]",
{{/FileFunction}}
Expand Down
Loading

0 comments on commit b709961

Please sign in to comment.