An Azure Functions app is running. Authorize this app and click below to call it for a response:
{loading && (
@@ -85,7 +85,7 @@ export function AzureFunctions(props) {
{!loading && !!data && !error && {JSON.stringify(data, null, 2)}}
{!loading && !data && !error && }
{!loading && !!error && {error.toString()}}
- How to edit the Azure Function
+ How to edit the Azure Functions
See the code in {codePath} to add your business logic.
diff --git a/templates/js/sso-tab-with-obo-flow/src/components/sample/EditCode.jsx b/templates/js/sso-tab-with-obo-flow/src/components/sample/EditCode.jsx
index 949ca752bb..861a7b21a4 100644
--- a/templates/js/sso-tab-with-obo-flow/src/components/sample/EditCode.jsx
+++ b/templates/js/sso-tab-with-obo-flow/src/components/sample/EditCode.jsx
@@ -6,8 +6,8 @@ var functionName = config.apiName || "myFunc";
export function EditCode(props) {
const { showFunction, tabCodeEntry, functionCodePath } = {
showFunction: true,
- tabCodeEntry: "tabs/src/index.jsx",
- functionCodePath: `api/${functionName}/index.js`,
+ tabCodeEntry: "src/index.jsx",
+ functionCodePath: `api/src/functions/${functionName}.js`,
...props,
};
return (
diff --git a/templates/js/sso-tab-with-obo-flow/teamsapp.local.yml.tpl b/templates/js/sso-tab-with-obo-flow/teamsapp.local.yml.tpl
index 7fcf3cfe29..fa5f1014d5 100644
--- a/templates/js/sso-tab-with-obo-flow/teamsapp.local.yml.tpl
+++ b/templates/js/sso-tab-with-obo-flow/teamsapp.local.yml.tpl
@@ -106,14 +106,12 @@ deploy:
func:
version: ~4.0.5455
symlinkDir: ./devTools/func
- dotnet: true
# Write the information of installed development tool(s) into environment
# file for the specified environment variable(s).
writeToEnvironmentFile:
sslCertFile: SSL_CRT_FILE
sslKeyFile: SSL_KEY_FILE
funcPath: FUNC_PATH
- dotnetPath: DOTNET_PATH
# Run npm command
- uses: cli/runNpmCommand
diff --git a/templates/js/workflow/package.json.tpl b/templates/js/workflow/package.json.tpl
index 6627d5e2ff..784a461916 100644
--- a/templates/js/workflow/package.json.tpl
+++ b/templates/js/workflow/package.json.tpl
@@ -23,7 +23,7 @@
},
"dependencies": {
"@microsoft/adaptivecards-tools": "^1.0.0",
- "@microsoft/teamsfx": "^2.2.0",
+ "@microsoft/teamsfx": "^2.3.1",
"botbuilder": "^4.20.0",
"restify": "^10.0.0"
},
@@ -31,4 +31,4 @@
"env-cmd": "^10.1.0",
"nodemon": "^2.0.7"
}
-}
+}
\ No newline at end of file
diff --git a/templates/js/workflow/teamsapp.local.yml.tpl b/templates/js/workflow/teamsapp.local.yml.tpl
index a886dfe614..5c51cea38d 100644
--- a/templates/js/workflow/teamsapp.local.yml.tpl
+++ b/templates/js/workflow/teamsapp.local.yml.tpl
@@ -15,15 +15,19 @@ provision:
teamsAppId: TEAMS_APP_ID
# Create or reuse an existing Microsoft Entra application for bot.
- - uses: botAadApp/create
+ - uses: aadApp/create
with:
# The Microsoft Entra application's display name
name: {{appName}}${{APP_NAME_SUFFIX}}
+ generateClientSecret: true
+ signInAudience: AzureADMultipleOrgs
writeToEnvironmentFile:
# The Microsoft Entra application's client id created for bot.
- botId: BOT_ID
+ clientId: BOT_ID
# The Microsoft Entra application's client secret created for bot.
- botPassword: SECRET_BOT_PASSWORD
+ clientSecret: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's object id created for bot.
+ objectId: BOT_OBJECT_ID
# Create or update the bot registration on dev.botframework.com
- uses: botFramework/create
diff --git a/templates/js/workflow/teamsapp.yml.tpl b/templates/js/workflow/teamsapp.yml.tpl
index e37a3d1e07..d690369df8 100644
--- a/templates/js/workflow/teamsapp.yml.tpl
+++ b/templates/js/workflow/teamsapp.yml.tpl
@@ -18,15 +18,19 @@ provision:
teamsAppId: TEAMS_APP_ID
# Create or reuse an existing Microsoft Entra application for bot.
- - uses: botAadApp/create
+ - uses: aadApp/create
with:
# The Microsoft Entra application's display name
name: {{appName}}${{APP_NAME_SUFFIX}}
+ generateClientSecret: true
+ signInAudience: AzureADMultipleOrgs
writeToEnvironmentFile:
# The Microsoft Entra application's client id created for bot.
- botId: BOT_ID
+ clientId: BOT_ID
# The Microsoft Entra application's client secret created for bot.
- botPassword: SECRET_BOT_PASSWORD
+ clientSecret: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's object id created for bot.
+ objectId: BOT_OBJECT_ID
- uses: arm/deploy # Deploy given ARM templates parallelly.
with:
diff --git a/templates/package.json b/templates/package.json
index a4190c5e6d..95deec28d9 100644
--- a/templates/package.json
+++ b/templates/package.json
@@ -1,6 +1,6 @@
{
"name": "templates",
- "version": "4.2.0-alpha",
+ "version": "4.2.0",
"private": "true",
"license": "MIT",
"scripts": {
diff --git a/templates/python/custom-copilot-basic/README.md.tpl b/templates/python/custom-copilot-basic/README.md.tpl
index c3e51444fc..3cee69b179 100644
--- a/templates/python/custom-copilot-basic/README.md.tpl
+++ b/templates/python/custom-copilot-basic/README.md.tpl
@@ -4,10 +4,10 @@ This template showcases a bot app that responds to user questions like an AI ass
The app template is built using the Teams AI library, which provides the capabilities to build AI-based Teams applications.
-- [Overview of the Basic AI Chatbot template](#overview-of-the-ai-chat-bot-template)
- - [Get started with the Basic AI Chatbot template](#get-started-with-the-ai-chat-bot-template)
+- [Overview of the Basic AI Chatbot template](#overview-of-the-basic-ai-chatbot-template)
+ - [Get started with the Basic AI Chatbot template](#get-started-with-the-basic-ai-chatbot-template)
- [What's included in the template](#whats-included-in-the-template)
- - [Extend the Basic AI Chatbot template with more AI capabilities](#extend-the-ai-chat-bot-template-with-more-ai-capabilities)
+ - [Extend the Basic AI Chatbot template with more AI capabilities](#extend-the-basic-ai-chatbot-template-with-more-ai-capabilities)
- [Additional information and references](#additional-information-and-references)
## Get started with the Basic AI Chatbot template
@@ -16,9 +16,9 @@ The app template is built using the Teams AI library, which provides the capabil
>
> To run the Basic AI Chatbot template in your local dev machine, you will need:
>
-> - [Python](https://www.python.org/), version 3.8 or higher
-> - [Python extension](https://code.visualstudio.com/docs/languages/python), version v2024.0.1 or higher
-> - [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-cli)
+> - [Python](https://www.python.org/), version 3.8 to 3.11.
+> - [Python extension](https://code.visualstudio.com/docs/languages/python), version v2024.0.1 or higher.
+> - [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) latest version or [Teams Toolkit CLI](https://aka.ms/teamsfx-cli).
{{#useAzureOpenAI}}
> - An account with [Azure OpenAI](https://aka.ms/oai/access).
{{/useAzureOpenAI}}
@@ -26,14 +26,14 @@ The app template is built using the Teams AI library, which provides the capabil
> - An account with [OpenAI](https://platform.openai.com/).
{{/useOpenAI}}
{{^enableTestToolByDefault}}
-> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts)
+> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts).
{{/enableTestToolByDefault}}
{{#enableTestToolByDefault}}
> - [Node.js](https://nodejs.org/) (supported versions: 16, 18) for local debug in Test Tool.
{{/enableTestToolByDefault}}
-1. First, Open the command box and enter `Python: Create Environment` to create and activate your desired virtual environment. Remember to select `src/requirements.txt` as dependencies to install when creating the virtual environment.
-1. select the Teams Toolkit icon on the left in the VS Code toolbar.
+### Configurations
+1. Open the command box and enter `Python: Create Environment` to create and activate your desired virtual environment. Remember to select `src/requirements.txt` as dependencies to install when creating the virtual environment.
{{#enableTestToolByDefault}}
{{#useAzureOpenAI}}
1. In file *env/.env.testtool.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_API_KEY`, deployment name `AZURE_OPENAI_MODEL_DEPLOYMENT_NAME` and endpoint `AZURE_OPENAI_ENDPOINT`.
@@ -42,15 +42,8 @@ The app template is built using the Teams AI library, which provides the capabil
1. In file *env/.env.testtool.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY`.
1. In this template, default model name is `gpt-3.5-turbo`. If you want to use a different model from OpenAI, fill in your model name in [src/config.py](./src/config.py).
{{/useOpenAI}}
-1. Press F5 to start debugging which launches your app in Teams App Test Tool using a web browser. Select `Debug in Test Tool (Preview)`.
-1. You will receive a welcome message from the bot, or send any message to get a response.
-
-**Congratulations**! You are running an application that can now interact with users in Teams App Test Tool:
-
-
{{/enableTestToolByDefault}}
{{^enableTestToolByDefault}}
-1. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't already.
{{#useAzureOpenAI}}
1. In file *env/.env.local.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_API_KEY`, deployment name `AZURE_OPENAI_MODEL_DEPLOYMENT_NAME` and endpoint `AZURE_OPENAI_ENDPOINT`.
{{/useAzureOpenAI}}
@@ -58,12 +51,26 @@ The app template is built using the Teams AI library, which provides the capabil
1. In file *env/.env.local.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY`.
1. In this template, default model name is `gpt-3.5-turbo`. If you want to use a different model from OpenAI, fill in your model name in [src/config.py](./src/config.py).
{{/useOpenAI}}
+{{/enableTestToolByDefault}}
+
+### Conversation with bot
+1. Select the Teams Toolkit icon on the left in the VS Code toolbar.
+{{#enableTestToolByDefault}}
+1. Press F5 to start debugging which launches your app in Teams App Test Tool using a web browser. Select `Debug in Test Tool (Preview)`.
+{{/enableTestToolByDefault}}
+{{^enableTestToolByDefault}}
+1. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't already.
1. Press F5 to start debugging which launches your app in Teams using a web browser. Select `Debug in Teams (Edge)` or `Debug in Teams (Chrome)`.
1. When Teams launches in the browser, select the Add button in the dialog to install your app to Teams.
+{{/enableTestToolByDefault}}
1. You will receive a welcome message from the bot, or send any message to get a response.
**Congratulations**! You are running an application that can now interact with users in Teams:
+{{#enableTestToolByDefault}}
+
+{{/enableTestToolByDefault}}
+{{^enableTestToolByDefault}}
{{/enableTestToolByDefault}}
@@ -109,4 +116,7 @@ You can follow [Build a Basic AI Chatbot in Teams](https://aka.ms/teamsfx-basic-
- [Teams AI library](https://aka.ms/teams-ai-library)
- [Teams Toolkit Documentations](https://docs.microsoft.com/microsoftteams/platform/toolkit/teams-toolkit-fundamentals)
- [Teams Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)
-- [Teams Toolkit Samples](https://github.com/OfficeDev/TeamsFx-Samples)
\ No newline at end of file
+- [Teams Toolkit Samples](https://github.com/OfficeDev/TeamsFx-Samples)
+
+## Known issue
+- If you use Test Tool to local debug, you might get an error `InternalServiceError: connect ECONNREFUSED 127.0.0.1:3978` in Test Tool log. You can wait for Python launch console ready and then refresh the front end web page.
\ No newline at end of file
diff --git a/templates/python/custom-copilot-basic/infra/azure.bicep.tpl b/templates/python/custom-copilot-basic/infra/azure.bicep.tpl
index 608b54e549..1f22628590 100644
--- a/templates/python/custom-copilot-basic/infra/azure.bicep.tpl
+++ b/templates/python/custom-copilot-basic/infra/azure.bicep.tpl
@@ -59,6 +59,10 @@ resource webApp 'Microsoft.Web/sites@2021-02-01' = {
appCommandLine: 'gunicorn --bind 0.0.0.0 --worker-class aiohttp.worker.GunicornWebWorker --timeout 600 app:app'
linuxFxVersion: pythonVersion
appSettings: [
+ {
+ name: 'WEBSITES_CONTAINER_START_TIME_LIMIT'
+ value: '600'
+ }
{
name: 'SCM_DO_BUILD_DURING_DEPLOYMENT'
value: 'true'
diff --git a/templates/python/custom-copilot-basic/src/requirements.txt b/templates/python/custom-copilot-basic/src/requirements.txt
index 32dea3ac52..1ba1feadad 100644
--- a/templates/python/custom-copilot-basic/src/requirements.txt
+++ b/templates/python/custom-copilot-basic/src/requirements.txt
@@ -1,3 +1,3 @@
python-dotenv
aiohttp
-teams-ai~=1.0.0
\ No newline at end of file
+teams-ai~=1.0.1
\ No newline at end of file
diff --git a/templates/python/custom-copilot-basic/teamsapp.local.yml.tpl b/templates/python/custom-copilot-basic/teamsapp.local.yml.tpl
index fd718b61e3..63e5646c6e 100644
--- a/templates/python/custom-copilot-basic/teamsapp.local.yml.tpl
+++ b/templates/python/custom-copilot-basic/teamsapp.local.yml.tpl
@@ -14,16 +14,20 @@ provision:
writeToEnvironmentFile:
teamsAppId: TEAMS_APP_ID
- # Create or reuse an existing Azure Active Directory application for bot.
- - uses: botAadApp/create
+ # Create or reuse an existing Microsoft Entra application for bot.
+ - uses: aadApp/create
with:
- # The Azure Active Directory application's display name
- name: {{appName}}-${{TEAMSFX_ENV}}
+ # The Microsoft Entra application's display name
+ name: {{appName}}${{APP_NAME_SUFFIX}}
+ generateClientSecret: true
+ signInAudience: AzureADMultipleOrgs
writeToEnvironmentFile:
- # The Azure Active Directory application's client id created for bot.
- botId: BOT_ID
- # The Azure Active Directory application's client secret created for bot.
- botPassword: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's client id created for bot.
+ clientId: BOT_ID
+ # The Microsoft Entra application's client secret created for bot.
+ clientSecret: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's object id created for bot.
+ objectId: BOT_OBJECT_ID
# Create or update the bot registration on dev.botframework.com
- uses: botFramework/create
diff --git a/templates/python/custom-copilot-basic/teamsapp.yml.tpl b/templates/python/custom-copilot-basic/teamsapp.yml.tpl
index 4dcf12589c..3f2f0de1e4 100644
--- a/templates/python/custom-copilot-basic/teamsapp.yml.tpl
+++ b/templates/python/custom-copilot-basic/teamsapp.yml.tpl
@@ -17,16 +17,20 @@ provision:
writeToEnvironmentFile:
teamsAppId: TEAMS_APP_ID
- # Create or reuse an existing Azure Active Directory application for bot.
- - uses: botAadApp/create
+ # Create or reuse an existing Microsoft Entra application for bot.
+ - uses: aadApp/create
with:
- # The Azure Active Directory application's display name
- name: {{appName}}-${{TEAMSFX_ENV}}
+ # The Microsoft Entra application's display name
+ name: {{appName}}${{APP_NAME_SUFFIX}}
+ generateClientSecret: true
+ signInAudience: AzureADMultipleOrgs
writeToEnvironmentFile:
- # The Azure Active Directory application's client id created for bot.
- botId: BOT_ID
- # The Azure Active Directory application's client secret created for bot.
- botPassword: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's client id created for bot.
+ clientId: BOT_ID
+ # The Microsoft Entra application's client secret created for bot.
+ clientSecret: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's object id created for bot.
+ objectId: BOT_OBJECT_ID
- uses: arm/deploy # Deploy given ARM templates parallelly.
with:
@@ -93,3 +97,40 @@ deploy:
# You can replace it with your existing Azure Resource id
# or add it to your environment variable file.
resourceId: ${{BOT_AZURE_APP_SERVICE_RESOURCE_ID}}
+
+# Triggered when 'teamsapp publish' is executed
+publish:
+ # Validate using manifest schema
+ - uses: teamsApp/validateManifest
+ with:
+ # Path to manifest template
+ manifestPath: ./appPackage/manifest.json
+ # Build Teams app package with latest env value
+ - uses: teamsApp/zipAppPackage
+ with:
+ # Path to manifest template
+ manifestPath: ./appPackage/manifest.json
+ outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+ outputJsonPath: ./appPackage/build/manifest.${{TEAMSFX_ENV}}.json
+ # Validate app package using validation rules
+ - uses: teamsApp/validateAppPackage
+ with:
+ # Relative path to this file. This is the path for built zip file.
+ appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+ # Apply the Teams app manifest to an existing Teams app in
+ # Teams Developer Portal.
+ # Will use the app id in manifest file to determine which Teams app to update.
+ - uses: teamsApp/update
+ with:
+ # Relative path to this file. This is the path for built zip file.
+ appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+ # Publish the app to
+ # Teams Admin Center (https://admin.teams.microsoft.com/policies/manage-apps)
+ # for review and approval
+ - uses: teamsApp/publishAppPackage
+ with:
+ appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+ # Write the information of created resources into environment file for
+ # the specified environment variable(s).
+ writeToEnvironmentFile:
+ publishedAppId: TEAMS_APP_PUBLISHED_APP_ID
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/.gitignore b/templates/python/custom-copilot-rag-azure-ai-search/.gitignore
new file mode 100644
index 0000000000..ec1f6285c6
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/.gitignore
@@ -0,0 +1,15 @@
+# TeamsFx files
+env/.env.*.user
+env/.env.local
+env/.env.testtool
+.env
+appPackage/build
+
+# python virtual environment
+.venv/
+__pycache__/
+
+# others
+.deployment/
+node_modules/
+devTools/*.log
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/.vscode/extensions.json b/templates/python/custom-copilot-rag-azure-ai-search/.vscode/extensions.json
new file mode 100644
index 0000000000..760a0b1d8f
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/.vscode/extensions.json
@@ -0,0 +1,6 @@
+{
+ "recommendations": [
+ "TeamsDevApp.ms-teams-vscode-extension",
+ "ms-python.python"
+ ]
+}
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/.vscode/launch.json.tpl b/templates/python/custom-copilot-rag-azure-ai-search/.vscode/launch.json.tpl
new file mode 100644
index 0000000000..f17c73596d
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/.vscode/launch.json.tpl
@@ -0,0 +1,134 @@
+{
+ "version": "0.2.0",
+ "configurations": [
+ {
+ "name": "Launch Remote in Teams (Edge)",
+ "type": "msedge",
+ "request": "launch",
+ "url": "https://teams.microsoft.com/l/app/${{TEAMS_APP_ID}}?installAppPackage=true&webjoin=true&${account-hint}",
+ "presentation": {
+ "group": "group 1: Teams",
+ "order": 3
+ },
+ "internalConsoleOptions": "neverOpen"
+ },
+ {
+ "name": "Launch Remote in Teams (Chrome)",
+ "type": "chrome",
+ "request": "launch",
+ "url": "https://teams.microsoft.com/l/app/${{TEAMS_APP_ID}}?installAppPackage=true&webjoin=true&${account-hint}",
+ "presentation": {
+ "group": "group 1: Teams",
+ "order": 3
+ },
+ "internalConsoleOptions": "neverOpen"
+ },
+ {
+ "name": "Launch App (Edge)",
+ "type": "msedge",
+ "request": "launch",
+ "url": "https://teams.microsoft.com/l/app/${{local:TEAMS_APP_ID}}?installAppPackage=true&webjoin=true&${account-hint}",
+ "presentation": {
+ "group": "all",
+ "hidden": true
+ },
+ "internalConsoleOptions": "neverOpen"
+ },
+ {
+ "name": "Launch App (Chrome)",
+ "type": "chrome",
+ "request": "launch",
+ "url": "https://teams.microsoft.com/l/app/${{local:TEAMS_APP_ID}}?installAppPackage=true&webjoin=true&${account-hint}",
+ "presentation": {
+ "group": "all",
+ "hidden": true
+ },
+ "internalConsoleOptions": "neverOpen"
+ },
+ {
+ "name": "Start Python",
+ "type": "debugpy",
+ "program": "${workspaceFolder}/src/app.py",
+ "request": "launch",
+ "cwd": "${workspaceFolder}/src/",
+ "console": "integratedTerminal",
+ },
+ {
+ "name": "Start Test Tool",
+ "type": "node",
+ "request": "launch",
+ "program": "${workspaceFolder}/devTools/teamsapptester/node_modules/@microsoft/teams-app-test-tool/cli.js",
+ "args": [
+ "start",
+ ],
+ "cwd": "${workspaceFolder}",
+ "console": "integratedTerminal",
+ "internalConsoleOptions": "neverOpen"
+ }
+ ],
+ "compounds": [
+ {
+ "name": "Debug (Edge)",
+ "configurations": [
+ "Launch App (Edge)",
+ "Start Python"
+ ],
+ "cascadeTerminateToConfigurations": [
+ "Start Python"
+ ],
+ "preLaunchTask": "Start Teams App Locally",
+ "presentation": {
+{{#enableTestToolByDefault}}
+ "group": "2-local",
+{{/enableTestToolByDefault}}
+{{^enableTestToolByDefault}}
+ "group": "1-local",
+{{/enableTestToolByDefault}}
+ "order": 1
+ },
+ "stopAll": true
+ },
+ {
+ "name": "Debug (Chrome)",
+ "configurations": [
+ "Launch App (Chrome)",
+ "Start Python"
+ ],
+ "cascadeTerminateToConfigurations": [
+ "Start Python"
+ ],
+ "preLaunchTask": "Start Teams App Locally",
+ "presentation": {
+{{#enableTestToolByDefault}}
+ "group": "2-local",
+{{/enableTestToolByDefault}}
+{{^enableTestToolByDefault}}
+ "group": "1-local",
+{{/enableTestToolByDefault}}
+ "order": 2
+ },
+ "stopAll": true
+ },
+ {
+ "name": "Debug in Test Tool (Preview)",
+ "configurations": [
+ "Start Python",
+ "Start Test Tool",
+ ],
+ "cascadeTerminateToConfigurations": [
+ "Start Test Tool"
+ ],
+ "preLaunchTask": "Deploy (Test Tool)",
+ "presentation": {
+{{#enableTestToolByDefault}}
+ "group": "1-local",
+{{/enableTestToolByDefault}}
+{{^enableTestToolByDefault}}
+ "group": "2-local",
+{{/enableTestToolByDefault}}
+ "order": 1
+ },
+ "stopAll": true
+ }
+ ]
+}
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/.vscode/settings.json b/templates/python/custom-copilot-rag-azure-ai-search/.vscode/settings.json
new file mode 100644
index 0000000000..0d3ba10b02
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/.vscode/settings.json
@@ -0,0 +1,11 @@
+{
+ "debug.onTaskErrors": "abort",
+ "json.schemas": [
+ {
+ "fileMatch": [
+ "/aad.*.json"
+ ],
+ "schema": {}
+ }
+ ]
+}
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/.vscode/tasks.json b/templates/python/custom-copilot-rag-azure-ai-search/.vscode/tasks.json
new file mode 100644
index 0000000000..cd77312c80
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/.vscode/tasks.json
@@ -0,0 +1,108 @@
+// This file is automatically generated by Teams Toolkit.
+// The teamsfx tasks defined in this file require Teams Toolkit version >= 5.0.0.
+// See https://aka.ms/teamsfx-tasks for details on how to customize each task.
+{
+ "version": "2.0.0",
+ "tasks": [
+ {
+ // Check all required prerequisites.
+ // See https://aka.ms/teamsfx-tasks/check-prerequisites to know the details and how to customize the args.
+ "label": "Validate prerequisites (Test Tool)",
+ "type": "teamsfx",
+ "command": "debug-check-prerequisites",
+ "args": {
+ "prerequisites": [
+ "nodejs", // Check if Node.js is installed and the version is >= 12.
+ "portOccupancy" // Validate available ports to ensure those debug ones are not occupied.
+ ],
+ "portOccupancy": [
+ 3978, // app service port
+ 56150, // test tool port
+ ]
+ }
+ },
+ {
+ // Build project.
+ // See https://aka.ms/teamsfx-tasks/deploy to know the details and how to customize the args.
+ "label": "Deploy (Test Tool)",
+ "dependsOn": [
+ "Validate prerequisites (Test Tool)"
+ ],
+ "type": "teamsfx",
+ "command": "deploy",
+ "args": {
+ "env": "testtool",
+ }
+ },
+ {
+ "label": "Start Teams App Locally",
+ "dependsOn": [
+ "Validate prerequisites",
+ "Start local tunnel",
+ "Provision",
+ "Deploy"
+ ],
+ "dependsOrder": "sequence"
+ },
+ {
+ // Check all required prerequisites.
+ // See https://aka.ms/teamsfx-tasks/check-prerequisites to know the details and how to customize the args.
+ "label": "Validate prerequisites",
+ "type": "teamsfx",
+ "command": "debug-check-prerequisites",
+ "args": {
+ "prerequisites": [
+ "m365Account", // Sign-in prompt for Microsoft 365 account, then validate if the account enables the sideloading permission.
+ "portOccupancy" // Validate available ports to ensure those debug ones are not occupied.
+ ],
+ "portOccupancy": [
+ 3978 // app service port
+ ]
+ }
+ },
+ {
+ // Start the local tunnel service to forward public URL to local port and inspect traffic.
+ // See https://aka.ms/teamsfx-tasks/local-tunnel for the detailed args definitions.
+ "label": "Start local tunnel",
+ "type": "teamsfx",
+ "command": "debug-start-local-tunnel",
+ "args": {
+ "type": "dev-tunnel",
+ "ports": [
+ {
+ "portNumber": 3978,
+ "protocol": "http",
+ "access": "public",
+ "writeToEnvironmentFile": {
+ "endpoint": "BOT_ENDPOINT", // output tunnel endpoint as BOT_ENDPOINT
+ "domain": "BOT_DOMAIN" // output tunnel domain as BOT_DOMAIN
+ }
+ }
+ ],
+ "env": "local"
+ },
+ "isBackground": true,
+ "problemMatcher": "$teamsfx-local-tunnel-watch"
+ },
+ {
+ // Create the debug resources.
+ // See https://aka.ms/teamsfx-tasks/provision to know the details and how to customize the args.
+ "label": "Provision",
+ "type": "teamsfx",
+ "command": "provision",
+ "args": {
+ "env": "local"
+ }
+ },
+ {
+ // Build project.
+ // See https://aka.ms/teamsfx-tasks/deploy to know the details and how to customize the args.
+ "label": "Deploy",
+ "type": "teamsfx",
+ "command": "deploy",
+ "args": {
+ "env": "local"
+ }
+ }
+ ]
+}
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/.webappignore b/templates/python/custom-copilot-rag-azure-ai-search/.webappignore
new file mode 100644
index 0000000000..fc2332c6bc
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/.webappignore
@@ -0,0 +1,15 @@
+.venv/
+.vscode/
+appPackage/
+devTools/
+infra/
+.env
+env/
+__pycache__/
+README.md
+teamsapp.yml
+teamsapp.local.yml
+teamsapp.testtool.yml
+.gitignore
+
+indexers/
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/README.md.tpl b/templates/python/custom-copilot-rag-azure-ai-search/README.md.tpl
new file mode 100644
index 0000000000..c5280bbabc
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/README.md.tpl
@@ -0,0 +1,148 @@
+# Overview of the AI Search Bot template
+
+This template showcases a bot app that responds to user questions like an AI assistant according to data from Azure Search. This enables your users to talk with the AI assistant in Teams to find information.
+
+The app template is built using the Teams AI library, which provides the capabilities to build AI-based Teams applications.
+
+- [Overview of the AI Search Bot template](#overview-of-the-ai-search-bot-template)
+ - [Get started with the AI Search Bot template](#get-started-with-the-ai-search-bot-template)
+ - [What's included in the template](#whats-included-in-the-template)
+ - [Extend the AI Search Bot template with more AI capabilities](#extend-the-ai-search-bot-template-with-more-ai-capabilities)
+ - [Additional information and references](#additional-information-and-references)
+
+## Get started with the AI Search Bot template
+
+> **Prerequisites**
+>
+> To run the AI Search Bot template in your local dev machine, you will need:
+>
+> - [Python](https://www.python.org/), version 3.8 to 3.11.
+> - [Python extension](https://code.visualstudio.com/docs/languages/python), version v2024.0.1 or higher.
+> - [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) latest version or [Teams Toolkit CLI](https://aka.ms/teamsfx-cli).
+{{#useAzureOpenAI}}
+> - An account with [Azure OpenAI](https://aka.ms/oai/access).
+{{/useAzureOpenAI}}
+{{#useOpenAI}}
+> - An account with [OpenAI](https://platform.openai.com/).
+{{/useOpenAI}}
+> - An [Azure Search service](https://learn.microsoft.com/en-us/azure/search/search-what-is-azure-search).
+{{^enableTestToolByDefault}}
+> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts).
+{{/enableTestToolByDefault}}
+{{#enableTestToolByDefault}}
+> - [Node.js](https://nodejs.org/) (supported versions: 16, 18) for local debug in Test Tool.
+{{/enableTestToolByDefault}}
+
+### Configurations
+1. Open the command box and enter `Python: Create Environment` to create and activate your desired virtual environment. Remember to select `src/requirements.txt` as dependencies to install when creating the virtual environment.
+{{#enableTestToolByDefault}}
+{{#useAzureOpenAI}}
+1. In file *env/.env.testtool.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_API_KEY`, deployment name `AZURE_OPENAI_MODEL_DEPLOYMENT_NAME`, endpoint `AZURE_OPENAI_ENDPOINT` and embedding deployment name `AZURE_OPENAI_EMBEDDING_DEPLOYMENT`.
+{{/useAzureOpenAI}}
+{{#useOpenAI}}
+1. In file *env/.env.testtool.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY`.
+1. In this template, default model name is `gpt-3.5-turbo` and default embedding model name is `text-embedding-ada-002`. If you want to use different models from OpenAI, fill in your model names in [src/config.py](./src/config.py).
+{{/useOpenAI}}
+1. In file *env/.env.local.user*, fill in your Azure Search key `SECRET_AZURE_SEARCH_KEY` and endpoint `AZURE_SEARCH_ENDPOINT`.
+{{/enableTestToolByDefault}}
+{{^enableTestToolByDefault}}
+{{#useAzureOpenAI}}
+1. In file *env/.env.local.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_API_KEY`, deployment name `AZURE_OPENAI_MODEL_DEPLOYMENT_NAME`, endpoint `AZURE_OPENAI_ENDPOINT` and embedding deployment name `AZURE_OPENAI_EMBEDDING_DEPLOYMENT`.
+{{/useAzureOpenAI}}
+{{#useOpenAI}}
+1. In file *env/.env.local.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY`.
+1. In this template, default model name is `gpt-3.5-turbo` and default embedding model name is `text-embedding-ada-002`. If you want to use different models from OpenAI, fill in your model names in [src/config.py](./src/config.py).
+{{/useOpenAI}}
+1. In file *env/.env.local.user*, fill in your Azure Search key `SECRET_AZURE_SEARCH_KEY` and endpoint `AZURE_SEARCH_ENDPOINT`.
+{{/enableTestToolByDefault}}
+
+### Setting up index and documents
+{{^enableTestToolByDefault}}
+1. Azure Search key `SECRET_AZURE_SEARCH_KEY` and endpoint `AZURE_SEARCH_ENDPOINT` are loaded from *env/.env.local.user*. Please make sure you have already configured them.
+{{/enableTestToolByDefault}}
+{{#enableTestToolByDefault}}
+1. Azure Search key `SECRET_AZURE_SEARCH_KEY` and endpoint `AZURE_SEARCH_ENDPOINT` are loaded from *env/.env.testtool.user*. Please make sure you have already configured them.
+{{/enableTestToolByDefault}}
+1. Use command `python src/indexers/setup.py` to create index and upload documents in `src/indexers/data`.
+1. You will see the following information indicated the success of setup:
+ ```
+ Create index succeeded. If it does not exist, wait for 5 seconds...
+ Upload new documents succeeded. If they do not exist, wait for several seconds...
+ setup finished
+ ```
+1. Once you're done using the sample it's good practice to delete the index. You can do so with the command `python src/indexers/delete.py`.
+
+### Conversation with bot
+1. Select the Teams Toolkit icon on the left in the VS Code toolbar.
+{{^enableTestToolByDefault}}
+1. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't already.
+1. Press F5 to start debugging which launches your app in Teams using a web browser. Select `Debug in Teams (Edge)` or `Debug in Teams (Chrome)`.
+1. When Teams launches in the browser, select the Add button in the dialog to install your app to Teams.
+{{/enableTestToolByDefault}}
+{{#enableTestToolByDefault}}
+1. Press F5 to start debugging which launches your app in Teams App Test Tool using a web browser. Select `Debug in Test Tool (Preview)`.
+{{/enableTestToolByDefault}}
+1. You will receive a welcome message from the bot, or send any message to get a response.
+
+**Congratulations**! You are running an application that can now interact with users in Teams:
+
+{{#enableTestToolByDefault}}
+
+{{/enableTestToolByDefault}}
+{{^enableTestToolByDefault}}
+
+{{/enableTestToolByDefault}}
+
+## What's included in the template
+
+| Folder | Contents |
+| - | - |
+| `.vscode` | VSCode files for debugging |
+| `appPackage` | Templates for the Teams application manifest |
+| `env` | Environment files |
+| `infra` | Templates for provisioning Azure resources |
+| `src` | The source code for the application |
+
+The following files can be customized and demonstrate an example implementation to get you started.
+
+| File | Contents |
+| - | - |
+|`src/bot.py`| Handles business logics for the AI Search Bot.|
+|`src/config.py`| Defines the environment variables.|
+|`src/app.py`| Main module of the AI Search Bot, hosts a aiohttp api server for the app.|
+|`src/azure_ai_search_data_source.py.py`| Handles data search logics.|
+|`src/prompts/chat/skprompt.txt`| Defines the prompt.|
+|`src/prompts/chat/config.json`| Configures the prompt.|
+
+The following files are scripts and raw texts that help you to prepare or clean data source in Azure Search.
+
+| File | Contents |
+| - | - |
+|`src/indexers/get_data.py`| Fetches data and creates embedding vectors.|
+|`src/indexers/data/*.md`| Raw text data source.|
+|`src/indexers/setup.py`| A script to create index and upload documents.|
+|`src/indexers/delete.py`| A script to delete index and documents.|
+
+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. |
+|`teamsapp.local.yml`|This overrides `teamsapp.yml` with actions that enable local execution and debugging.|
+|`teamsapp.testtool.yml`|This overrides `teamsapp.yml` with actions that enable local execution and debugging in Teams App Test Tool.|
+
+## Extend the Basic AI Chatbot template with more AI capabilities
+
+You can follow [Build a Basic AI Chatbot in Teams](https://aka.ms/teamsfx-basic-ai-chatbot) to extend the Basic AI Chatbot template with more AI capabilities, like:
+- [Customize prompt](https://aka.ms/teamsfx-basic-ai-chatbot#customize-prompt)
+- [Customize user input](https://aka.ms/teamsfx-basic-ai-chatbot#customize-user-input)
+- [Customize conversation history](https://aka.ms/teamsfx-basic-ai-chatbot#customize-conversation-history)
+- [Customize model type](https://aka.ms/teamsfx-basic-ai-chatbot#customize-model-type)
+- [Customize model parameters](https://aka.ms/teamsfx-basic-ai-chatbot#customize-model-parameters)
+- [Handle messages with image](https://aka.ms/teamsfx-basic-ai-chatbot#handle-messages-with-image)
+
+## Additional information and references
+- [Teams AI library](https://aka.ms/teams-ai-library)
+- [Teams Toolkit Documentations](https://docs.microsoft.com/microsoftteams/platform/toolkit/teams-toolkit-fundamentals)
+- [Teams Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)
+- [Teams Toolkit Samples](https://github.com/OfficeDev/TeamsFx-Samples)
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/appPackage/color.png b/templates/python/custom-copilot-rag-azure-ai-search/appPackage/color.png
new file mode 100644
index 0000000000..2d7e85c9e9
Binary files /dev/null and b/templates/python/custom-copilot-rag-azure-ai-search/appPackage/color.png differ
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/appPackage/manifest.json.tpl b/templates/python/custom-copilot-rag-azure-ai-search/appPackage/manifest.json.tpl
new file mode 100644
index 0000000000..1309b98c88
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/appPackage/manifest.json.tpl
@@ -0,0 +1,46 @@
+{
+ "$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.16/MicrosoftTeams.schema.json",
+ "manifestVersion": "1.16",
+ "version": "1.0.0",
+ "id": "${{TEAMS_APP_ID}}",
+ "packageName": "com.microsoft.teams.extension",
+ "developer": {
+ "name": "Teams App, Inc.",
+ "websiteUrl": "https://www.example.com",
+ "privacyUrl": "https://www.example.com/privacy",
+ "termsOfUseUrl": "https://www.example.com/termofuse"
+ },
+ "icons": {
+ "color": "color.png",
+ "outline": "outline.png"
+ },
+ "name": {
+ "short": "{{appName}}${{APP_NAME_SUFFIX}}",
+ "full": "full name for {{appName}}"
+ },
+ "description": {
+ "short": "short description for {{appName}}",
+ "full": "full description for {{appName}}"
+ },
+ "accentColor": "#FFFFFF",
+ "bots": [
+ {
+ "botId": "${{BOT_ID}}",
+ "scopes": [
+ "personal",
+ "team",
+ "groupchat"
+ ],
+ "supportsFiles": false,
+ "isNotificationOnly": false
+ }
+ ],
+ "composeExtensions": [],
+ "configurableTabs": [],
+ "staticTabs": [],
+ "permissions": [
+ "identity",
+ "messageTeamMembers"
+ ],
+ "validDomains": []
+}
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/appPackage/outline.png b/templates/python/custom-copilot-rag-azure-ai-search/appPackage/outline.png
new file mode 100644
index 0000000000..e8cb4b6ba4
Binary files /dev/null and b/templates/python/custom-copilot-rag-azure-ai-search/appPackage/outline.png differ
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/env/.env.dev b/templates/python/custom-copilot-rag-azure-ai-search/env/.env.dev
new file mode 100644
index 0000000000..8172044cec
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/env/.env.dev
@@ -0,0 +1,17 @@
+# This file includes environment variables that will be committed to git by default.
+
+# Built-in environment variables
+TEAMSFX_ENV=dev
+APP_NAME_SUFFIX=dev
+
+# Updating AZURE_SUBSCRIPTION_ID or AZURE_RESOURCE_GROUP_NAME after provision may also require an update to RESOURCE_SUFFIX, because some services require a globally unique name across subscriptions/resource groups.
+AZURE_SUBSCRIPTION_ID=
+AZURE_RESOURCE_GROUP_NAME=
+RESOURCE_SUFFIX=
+
+# Generated during provision, you can also add your own variables.
+BOT_ID=
+TEAMS_APP_ID=
+TEAMS_APP_TENANT_ID=
+BOT_AZURE_APP_SERVICE_RESOURCE_ID=
+BOT_DOMAIN=
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/env/.env.dev.user.tpl b/templates/python/custom-copilot-rag-azure-ai-search/env/.env.dev.user.tpl
new file mode 100644
index 0000000000..947e5a84e4
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/env/.env.dev.user.tpl
@@ -0,0 +1,31 @@
+# This file includes environment variables that will not be committed to git by default. You can set these environment variables in your CI/CD system for your project.
+
+# Secrets. Keys prefixed with `SECRET_` will be masked in Teams Toolkit logs.
+SECRET_BOT_PASSWORD=
+{{#useOpenAI}}
+{{#openAIKey}}
+SECRET_OPENAI_API_KEY='{{{openAIKey}}}'
+{{/openAIKey}}
+{{^openAIKey}}
+SECRET_OPENAI_API_KEY=
+{{/openAIKey}}
+{{/useOpenAI}}
+{{#useAzureOpenAI}}
+{{#azureOpenAIKey}}
+SECRET_AZURE_OPENAI_API_KEY='{{{azureOpenAIKey}}}'
+{{/azureOpenAIKey}}
+{{^azureOpenAIKey}}
+SECRET_AZURE_OPENAI_API_KEY=
+{{/azureOpenAIKey}}
+AZURE_OPENAI_MODEL_DEPLOYMENT_NAME=
+{{#azureOpenAIEndpoint}}
+AZURE_OPENAI_ENDPOINT='{{{azureOpenAIEndpoint}}}'
+{{/azureOpenAIEndpoint}}
+{{^azureOpenAIEndpoint}}
+AZURE_OPENAI_ENDPOINT=
+{{/azureOpenAIEndpoint}}
+AZURE_OPENAI_EMBEDDING_DEPLOYMENT=
+{{/useAzureOpenAI}}
+
+SECRET_AZURE_SEARCH_KEY=
+AZURE_SEARCH_ENDPOINT=
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/env/.env.local b/templates/python/custom-copilot-rag-azure-ai-search/env/.env.local
new file mode 100644
index 0000000000..589a4dea65
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/env/.env.local
@@ -0,0 +1,12 @@
+# This file includes environment variables that can be committed to git. It's gitignored by default because it represents your local development environment.
+
+# Built-in environment variables
+TEAMSFX_ENV=local
+APP_NAME_SUFFIX=local
+
+# Generated during provision, you can also add your own variables.
+BOT_ID=
+TEAMS_APP_ID=
+TEAMS_APP_TENANT_ID=
+BOT_DOMAIN=
+BOT_ENDPOINT=
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/env/.env.local.user.tpl b/templates/python/custom-copilot-rag-azure-ai-search/env/.env.local.user.tpl
new file mode 100644
index 0000000000..0d32eb7c2c
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/env/.env.local.user.tpl
@@ -0,0 +1,32 @@
+# This file includes environment variables that will not be committed to git by default. You can set these environment variables in your CI/CD system for your project.
+
+# If you're adding a secret value, add SECRET_ prefix to the name so Teams Toolkit can handle them properly
+# Secrets. Keys prefixed with `SECRET_` will be masked in Teams Toolkit logs.
+SECRET_BOT_PASSWORD=
+{{#useOpenAI}}
+{{#openAIKey}}
+SECRET_OPENAI_API_KEY='{{{openAIKey}}}'
+{{/openAIKey}}
+{{^openAIKey}}
+SECRET_OPENAI_API_KEY=
+{{/openAIKey}}
+{{/useOpenAI}}
+{{#useAzureOpenAI}}
+{{#azureOpenAIKey}}
+SECRET_AZURE_OPENAI_API_KEY='{{{azureOpenAIKey}}}'
+{{/azureOpenAIKey}}
+{{^azureOpenAIKey}}
+SECRET_AZURE_OPENAI_API_KEY=
+{{/azureOpenAIKey}}
+AZURE_OPENAI_MODEL_DEPLOYMENT_NAME=
+{{#azureOpenAIEndpoint}}
+AZURE_OPENAI_ENDPOINT='{{{azureOpenAIEndpoint}}}'
+{{/azureOpenAIEndpoint}}
+{{^azureOpenAIEndpoint}}
+AZURE_OPENAI_ENDPOINT=
+{{/azureOpenAIEndpoint}}
+AZURE_OPENAI_EMBEDDING_DEPLOYMENT=
+{{/useAzureOpenAI}}
+
+SECRET_AZURE_SEARCH_KEY=
+AZURE_SEARCH_ENDPOINT=
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/env/.env.testtool b/templates/python/custom-copilot-rag-azure-ai-search/env/.env.testtool
new file mode 100644
index 0000000000..53abad07db
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/env/.env.testtool
@@ -0,0 +1,8 @@
+# This file includes environment variables that can be committed to git. It's gitignored by default because it represents your local development environment.
+
+# Built-in environment variables
+TEAMSFX_ENV=testtool
+
+# Environment variables used by test tool
+TEAMSAPPTESTER_PORT=56150
+TEAMSFX_NOTIFICATION_STORE_FILENAME=.notification.testtoolstore.json
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/env/.env.testtool.user.tpl b/templates/python/custom-copilot-rag-azure-ai-search/env/.env.testtool.user.tpl
new file mode 100644
index 0000000000..0d32eb7c2c
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/env/.env.testtool.user.tpl
@@ -0,0 +1,32 @@
+# This file includes environment variables that will not be committed to git by default. You can set these environment variables in your CI/CD system for your project.
+
+# If you're adding a secret value, add SECRET_ prefix to the name so Teams Toolkit can handle them properly
+# Secrets. Keys prefixed with `SECRET_` will be masked in Teams Toolkit logs.
+SECRET_BOT_PASSWORD=
+{{#useOpenAI}}
+{{#openAIKey}}
+SECRET_OPENAI_API_KEY='{{{openAIKey}}}'
+{{/openAIKey}}
+{{^openAIKey}}
+SECRET_OPENAI_API_KEY=
+{{/openAIKey}}
+{{/useOpenAI}}
+{{#useAzureOpenAI}}
+{{#azureOpenAIKey}}
+SECRET_AZURE_OPENAI_API_KEY='{{{azureOpenAIKey}}}'
+{{/azureOpenAIKey}}
+{{^azureOpenAIKey}}
+SECRET_AZURE_OPENAI_API_KEY=
+{{/azureOpenAIKey}}
+AZURE_OPENAI_MODEL_DEPLOYMENT_NAME=
+{{#azureOpenAIEndpoint}}
+AZURE_OPENAI_ENDPOINT='{{{azureOpenAIEndpoint}}}'
+{{/azureOpenAIEndpoint}}
+{{^azureOpenAIEndpoint}}
+AZURE_OPENAI_ENDPOINT=
+{{/azureOpenAIEndpoint}}
+AZURE_OPENAI_EMBEDDING_DEPLOYMENT=
+{{/useAzureOpenAI}}
+
+SECRET_AZURE_SEARCH_KEY=
+AZURE_SEARCH_ENDPOINT=
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/infra/azure.bicep.tpl b/templates/python/custom-copilot-rag-azure-ai-search/infra/azure.bicep.tpl
new file mode 100644
index 0000000000..611c5eb17d
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/infra/azure.bicep.tpl
@@ -0,0 +1,135 @@
+@maxLength(20)
+@minLength(4)
+@description('Used to generate names for all resources in this file')
+param resourceBaseName string
+
+@description('Required when create Azure Bot service')
+param botAadAppClientId string
+
+@secure()
+@description('Required by Bot Framework package in your bot project')
+param botAadAppClientSecret string
+
+{{#useAzureOpenAI}}
+@secure()
+@description('Required in your bot project to access Azure OpenAI service. You can get it from Azure Portal > OpenAI > Keys > Key1 > Resource Management > Endpoint')
+param azureOpenaiKey string
+param azureOpenaiModelDeploymentName string
+param azureOpenaiEndpoint string
+param azureOpenaiEmbeddingDeployment string
+{{/useAzureOpenAI}}
+{{#useOpenAI}}
+@secure()
+@description('Required in your bot project to access OpenAI service. You can get it from OpenAI > API > API Key')
+param openaiKey string
+{{/useOpenAI}}
+
+@secure()
+@description('Required in your bot project to access Azure Search service. You can get it from Azure Portal > Azure Search > Keys > Admin Key')
+param azureSearchKey string
+param azureSearchEndpoint string
+
+param webAppSKU string
+param linuxFxVersion string
+
+@maxLength(42)
+param botDisplayName string
+
+param serverfarmsName string = resourceBaseName
+param webAppName string = resourceBaseName
+param location string = resourceGroup().location
+param pythonVersion string = linuxFxVersion
+
+// Compute resources for your Web App
+resource serverfarm 'Microsoft.Web/serverfarms@2021-02-01' = {
+ kind: 'app,linux'
+ location: location
+ name: serverfarmsName
+ sku: {
+ name: webAppSKU
+ }
+ properties:{
+ reserved: true
+ }
+}
+
+// Web App that hosts your bot
+resource webApp 'Microsoft.Web/sites@2021-02-01' = {
+ kind: 'app,linux'
+ location: location
+ name: webAppName
+ properties: {
+ serverFarmId: serverfarm.id
+ siteConfig: {
+ alwaysOn: true
+ appCommandLine: 'gunicorn --bind 0.0.0.0 --worker-class aiohttp.worker.GunicornWebWorker --timeout 600 app:app'
+ linuxFxVersion: pythonVersion
+ appSettings: [
+ {
+ name: 'WEBSITES_CONTAINER_START_TIME_LIMIT'
+ value: '600'
+ }
+ {
+ name: 'SCM_DO_BUILD_DURING_DEPLOYMENT'
+ value: 'true'
+ }
+ {
+ name: 'BOT_ID'
+ value: botAadAppClientId
+ }
+ {
+ name: 'BOT_PASSWORD'
+ value: botAadAppClientSecret
+ }
+ {{#useAzureOpenAI}}
+ {
+ name: 'AZURE_OPENAI_API_KEY'
+ value: azureOpenaiKey
+ }
+ {
+ name: 'AZURE_OPENAI_MODEL_DEPLOYMENT_NAME'
+ value: azureOpenaiModelDeploymentName
+ }
+ {
+ name: 'AZURE_OPENAI_ENDPOINT'
+ value: azureOpenaiEndpoint
+ }
+ {
+ name: 'AZURE_OPENAI_EMBEDDING_DEPLOYMENT'
+ value: azureOpenaiEmbeddingDeployment
+ }
+ {{/useAzureOpenAI}}
+ {{#useOpenAI}}
+ {
+ name: 'OPENAI_API_KEY'
+ value: openaiKey
+ }
+ {{/useOpenAI}}
+ {
+ name: 'AZURE_SEARCH_KEY'
+ value: azureSearchKey
+ }
+ {
+ name: 'AZURE_SEARCH_ENDPOINT'
+ value: azureSearchEndpoint
+ }
+ ]
+ ftpsState: 'FtpsOnly'
+ }
+ }
+}
+
+// Register your web service as a bot with the Bot Framework
+module azureBotRegistration './botRegistration/azurebot.bicep' = {
+ name: 'Azure-Bot-registration'
+ params: {
+ resourceBaseName: resourceBaseName
+ botAadAppClientId: botAadAppClientId
+ botAppDomain: webApp.properties.defaultHostName
+ botDisplayName: botDisplayName
+ }
+}
+
+// The output will be persisted in .env.{envName}. Visit https://aka.ms/teamsfx-actions/arm-deploy for more details.
+output BOT_AZURE_APP_SERVICE_RESOURCE_ID string = webApp.id
+output BOT_DOMAIN string = webApp.properties.defaultHostName
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/infra/azure.parameters.json.tpl b/templates/python/custom-copilot-rag-azure-ai-search/infra/azure.parameters.json.tpl
new file mode 100644
index 0000000000..9e608ebeca
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/infra/azure.parameters.json.tpl
@@ -0,0 +1,49 @@
+{
+ "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
+ "contentVersion": "1.0.0.0",
+ "parameters": {
+ "resourceBaseName": {
+ "value": "bot${{RESOURCE_SUFFIX}}"
+ },
+ "botAadAppClientId": {
+ "value": "${{BOT_ID}}"
+ },
+ "botAadAppClientSecret": {
+ "value": "${{SECRET_BOT_PASSWORD}}"
+ },
+ {{#useAzureOpenAI}}
+ "azureOpenaiKey": {
+ "value": "${{SECRET_AZURE_OPENAI_API_KEY}}"
+ },
+ "azureOpenaiModelDeploymentName" : {
+ "value": "${{AZURE_OPENAI_MODEL_DEPLOYMENT_NAME}}"
+ },
+ "azureOpenaiEndpoint" : {
+ "value": "${{AZURE_OPENAI_ENDPOINT}}"
+ },
+ "azureOpenaiEmbeddingDeployment" : {
+ "value": "${{AZURE_OPENAI_EMBEDDING_DEPLOYMENT}}"
+ },
+ {{/useAzureOpenAI}}
+ {{#useOpenAI}}
+ "openaiKey": {
+ "value": "${{SECRET_OPENAI_API_KEY}}"
+ },
+ {{/useOpenAI}}
+ "azureSearchKey": {
+ "value": "${{SECRET_AZURE_SEARCH_KEY}}"
+ },
+ "azureSearchEndpoint": {
+ "value": "${{AZURE_SEARCH_ENDPOINT}}"
+ },
+ "webAppSKU": {
+ "value": "B1"
+ },
+ "botDisplayName": {
+ "value": "AISearch-py"
+ },
+ "linuxFxVersion": {
+ "value": "PYTHON|3.11"
+ }
+ }
+}
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/infra/botRegistration/azurebot.bicep b/templates/python/custom-copilot-rag-azure-ai-search/infra/botRegistration/azurebot.bicep
new file mode 100644
index 0000000000..ab67c7a56b
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/infra/botRegistration/azurebot.bicep
@@ -0,0 +1,37 @@
+@maxLength(20)
+@minLength(4)
+@description('Used to generate names for all resources in this file')
+param resourceBaseName string
+
+@maxLength(42)
+param botDisplayName string
+
+param botServiceName string = resourceBaseName
+param botServiceSku string = 'F0'
+param botAadAppClientId string
+param botAppDomain string
+
+// Register your web service as a bot with the Bot Framework
+resource botService 'Microsoft.BotService/botServices@2021-03-01' = {
+ kind: 'azurebot'
+ location: 'global'
+ name: botServiceName
+ properties: {
+ displayName: botDisplayName
+ endpoint: 'https://${botAppDomain}/api/messages'
+ msaAppId: botAadAppClientId
+ }
+ sku: {
+ name: botServiceSku
+ }
+}
+
+// Connect the bot service to Microsoft Teams
+resource botServiceMsTeamsChannel 'Microsoft.BotService/botServices/channels@2021-03-01' = {
+ parent: botService
+ location: 'global'
+ name: 'MsTeamsChannel'
+ properties: {
+ channelName: 'MsTeamsChannel'
+ }
+}
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/infra/botRegistration/readme.md b/templates/python/custom-copilot-rag-azure-ai-search/infra/botRegistration/readme.md
new file mode 100644
index 0000000000..d5416243cd
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/infra/botRegistration/readme.md
@@ -0,0 +1 @@
+The `azurebot.bicep` module is provided to help you create Azure Bot service when you don't use Azure to host your app. If you use Azure as infrastrcture for your app, `azure.bicep` under infra folder already leverages this module to create Azure Bot service for you. You don't need to deploy `azurebot.bicep` again.
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/src/app.py b/templates/python/custom-copilot-rag-azure-ai-search/src/app.py
new file mode 100644
index 0000000000..910476d014
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/src/app.py
@@ -0,0 +1,30 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+import asyncio
+from http import HTTPStatus
+from aiohttp import web
+from botbuilder.core.integration import aiohttp_error_middleware
+
+from bot import bot_app
+
+routes = web.RouteTableDef()
+
+@routes.post("/api/messages")
+async def on_messages(req: web.Request) -> web.Response:
+ res = await bot_app.process(req)
+
+ if res is not None:
+ return res
+
+ return web.Response(status=HTTPStatus.OK)
+
+app = web.Application(middlewares=[aiohttp_error_middleware])
+app.add_routes(routes)
+
+from config import Config
+
+if __name__ == "__main__":
+ web.run_app(app, host="localhost", port=Config.PORT)
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/src/azure_ai_search_data_source.py.tpl b/templates/python/custom-copilot-rag-azure-ai-search/src/azure_ai_search_data_source.py.tpl
new file mode 100644
index 0000000000..c23e4c42c3
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/src/azure_ai_search_data_source.py.tpl
@@ -0,0 +1,111 @@
+from dataclasses import dataclass
+from typing import Optional, List
+from azure.search.documents.indexes.models import _edm as EDM
+from azure.search.documents.models import VectorQuery, VectorizedQuery
+{{#useAzureOpenAI}}
+from teams.ai.embeddings import AzureOpenAIEmbeddings, AzureOpenAIEmbeddingsOptions
+{{/useAzureOpenAI}}
+{{#useOpenAI}}
+from teams.ai.embeddings import OpenAIEmbeddings, OpenAIEmbeddingsOptions
+{{/useOpenAI}}
+from teams.state.memory import Memory
+from teams.state.state import TurnContext
+from teams.ai.tokenizers import Tokenizer
+from teams.ai.data_sources import DataSource
+
+from config import Config
+
+async def get_embedding_vector(text: str):
+ {{#useAzureOpenAI}}
+ embeddings = AzureOpenAIEmbeddings(AzureOpenAIEmbeddingsOptions(
+ azure_api_key=Config.AZURE_OPENAI_API_KEY,
+ azure_endpoint=Config.AZURE_OPENAI_ENDPOINT,
+ azure_deployment=Config.AZURE_OPENAI_EMBEDDING_DEPLOYMENT
+ ))
+ {{/useAzureOpenAI}}
+ {{#useOpenAI}}
+ embedding=OpenAIEmbeddings(OpenAIEmbeddingsOptions(
+ api_key=Config.OPENAI_API_KEY,
+ model=Config.OPENAI_EMBEDDING_DEPLOYMENT,
+ ))
+ {{/useOpenAI}}
+
+ result = await embeddings.create_embeddings(text)
+ if (result.status != 'success' or not result.output):
+ raise Exception(f"Failed to generate embeddings for description: {text}")
+
+ return result.output[0]
+
+@dataclass
+class Doc:
+ docId: Optional[str] = None
+ docTitle: Optional[str] = None
+ description: Optional[str] = None
+ descriptionVector: Optional[List[float]] = None
+
+@dataclass
+class AzureAISearchDataSourceOptions:
+ name: str
+ indexName: str
+ azureAISearchApiKey: str
+ azureAISearchEndpoint: str
+
+from azure.core.credentials import AzureKeyCredential
+from azure.search.documents import SearchClient
+import json
+
+@dataclass
+class Result:
+ def __init__(self, output, length, too_long):
+ self.output = output
+ self.length = length
+ self.too_long = too_long
+
+class AzureAISearchDataSource(DataSource):
+ def __init__(self, options: AzureAISearchDataSourceOptions):
+ self.name = options.name
+ self.options = options
+ self.searchClient = SearchClient(
+ options.azureAISearchEndpoint,
+ options.indexName,
+ AzureKeyCredential(options.azureAISearchApiKey)
+ )
+
+ def name(self):
+ return self.name
+
+ async def render_data(self, _context: TurnContext, memory: Memory, tokenizer: Tokenizer, maxTokens: int):
+ query = memory.get('temp.input')
+ embedding = await get_embedding_vector(query)
+ vector_query = VectorizedQuery(vector=embedding, k_nearest_neighbors=2, fields="descriptionVector")
+
+ if not query:
+ return Result('', 0, False)
+
+ selectedFields = [
+ 'docTitle',
+ 'description',
+ 'descriptionVector',
+ ]
+
+ searchResults = self.searchClient.search(
+ search_text=query,
+ select=selectedFields,
+ vector_queries=[vector_query],
+ )
+
+ if not searchResults:
+ return Result('', 0, False)
+
+ usedTokens = 0
+ doc = ''
+ for result in searchResults:
+ tokens = len(tokenizer.encode(json.dumps(result["description"])))
+
+ if usedTokens + tokens > maxTokens:
+ break
+
+ doc += json.dumps(result["description"])
+ usedTokens += tokens
+
+ return Result(doc, usedTokens, usedTokens > maxTokens)
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/src/bot.py.tpl b/templates/python/custom-copilot-rag-azure-ai-search/src/bot.py.tpl
new file mode 100644
index 0000000000..c4be18578a
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/src/bot.py.tpl
@@ -0,0 +1,85 @@
+import asyncio
+from dataclasses import dataclass
+import json
+import os
+import sys
+import traceback
+from typing import Generic, TypeVar
+
+from botbuilder.core import MemoryStorage, TurnContext
+from teams import Application, ApplicationOptions, TeamsAdapter
+from teams.ai import AIOptions
+from teams.ai.models import AzureOpenAIModelOptions, OpenAIModel, OpenAIModelOptions
+from teams.ai.planners import ActionPlanner, ActionPlannerOptions
+from teams.ai.prompts import PromptManager, PromptManagerOptions
+from teams.ai.actions import ActionTypes
+from teams.state import TurnState
+
+from azure_ai_search_data_source import AzureAISearchDataSource, AzureAISearchDataSourceOptions
+from config import Config
+
+config = Config()
+
+# Create AI components
+model: OpenAIModel
+
+{{#useAzureOpenAI}}
+model = OpenAIModel(
+ AzureOpenAIModelOptions(
+ api_key=config.AZURE_OPENAI_API_KEY,
+ default_model=config.AZURE_OPENAI_MODEL_DEPLOYMENT_NAME,
+ endpoint=config.AZURE_OPENAI_ENDPOINT,
+ )
+)
+{{/useAzureOpenAI}}
+{{#useOpenAI}}
+model = OpenAIModel(
+ OpenAIModelOptions(
+ api_key=config.OPENAI_API_KEY,
+ default_model=config.OPENAI_MODEL_NAME,
+ )
+)
+{{/useOpenAI}}
+
+prompts = PromptManager(PromptManagerOptions(prompts_folder=f"{os.getcwd()}/prompts"))
+
+prompts.add_data_source(
+ AzureAISearchDataSource(
+ AzureAISearchDataSourceOptions(
+ name='azure-ai-search',
+ indexName='contoso-electronics',
+ azureAISearchApiKey=config.AZURE_SEARCH_KEY,
+ azureAISearchEndpoint=config.AZURE_SEARCH_ENDPOINT,
+ )
+ )
+)
+
+planner = ActionPlanner(
+ ActionPlannerOptions(model=model, prompts=prompts, default_prompt="chat")
+)
+
+# Define storage and application
+storage = MemoryStorage()
+bot_app = Application[TurnState](
+ ApplicationOptions(
+ bot_app_id=config.APP_ID,
+ storage=storage,
+ adapter=TeamsAdapter(config),
+ ai=AIOptions(planner=planner),
+ )
+)
+
+@bot_app.conversation_update("membersAdded")
+async def on_members_added(context: TurnContext, state: TurnState):
+ await context.send_activity("How can I help you today?")
+
+@bot_app.error
+async def on_error(context: TurnContext, error: Exception):
+ # This check writes out errors to console log .vs. app insights.
+ # NOTE: In production environment, you should consider logging this to Azure
+ # application insights.
+ print(f"\n [on_turn_error] unhandled error: {error}", file=sys.stderr)
+ traceback.print_exc()
+
+ # Send a message to the user
+ await context.send_activity("The bot encountered an error or bug.")
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/src/config.py.tpl b/templates/python/custom-copilot-rag-azure-ai-search/src/config.py.tpl
new file mode 100644
index 0000000000..0b61ca9113
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/src/config.py.tpl
@@ -0,0 +1,31 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+import os
+
+from dotenv import load_dotenv
+
+load_dotenv()
+
+class Config:
+ """Bot Configuration"""
+
+ PORT = 3978
+ APP_ID = os.environ.get("BOT_ID", "")
+ APP_PASSWORD = os.environ.get("BOT_PASSWORD", "")
+ {{#useAzureOpenAI}}
+ AZURE_OPENAI_API_KEY = os.environ["AZURE_OPENAI_API_KEY"] # Azure OpenAI API key
+ AZURE_OPENAI_MODEL_DEPLOYMENT_NAME = os.environ["AZURE_OPENAI_MODEL_DEPLOYMENT_NAME"] # Azure OpenAI model deployment name
+ AZURE_OPENAI_ENDPOINT = os.environ["AZURE_OPENAI_ENDPOINT"] # Azure OpenAI endpoint
+ AZURE_OPENAI_EMBEDDING_DEPLOYMENT = os.environ["AZURE_OPENAI_EMBEDDING_DEPLOYMENT"] # Azure OpenAI embedding deployment
+ {{/useAzureOpenAI}}
+ {{#useOpenAI}}
+ OPENAI_API_KEY = os.environ["OPENAI_API_KEY"] # OpenAI API key
+ OPENAI_MODEL_NAME='gpt-3.5-turbo' # OpenAI model name. You can use any other model name from OpenAI.
+ OPENAI_EMBEDDING_DEPLOYMENT='text-embedding-ada-002' # OpenAI embedding model. You can use any other embedding model from OpenAI.
+ {{/useOpenAI}}
+ AZURE_SEARCH_KEY = os.environ["AZURE_SEARCH_KEY"] # Azure Search key
+ AZURE_SEARCH_ENDPOINT = os.environ["AZURE_SEARCH_ENDPOINT"] # Azure Search endpoint
+
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/data/Contoso_Electronics_Company_Overview.md b/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/data/Contoso_Electronics_Company_Overview.md
new file mode 100644
index 0000000000..6878a8e204
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/data/Contoso_Electronics_Company_Overview.md
@@ -0,0 +1,48 @@
+# Contoso Electronics Company Overview
+
+*Disclaimer: This document contains information generated using a language model (Azure OpenAI). The information contained in this document is only for demonstration purposes and does not reflect the opinions or beliefs of Microsoft. Microsoft makes no representations or warranties of any kind, express or implied, about the completeness, accuracy, reliability, suitability or availability with respect to the information contained in this document. All rights reserved to Microsoft.*
+
+## History
+
+Contoso Electronics, a pioneering force in the tech industry, was founded in 1985 by visionary entrepreneurs with a passion for innovation. Over the years, the company has played a pivotal role in shaping the landscape of consumer electronics.
+
+| Year | Milestone |
+|------|-----------|
+| 1985 | Company founded with a focus on cutting-edge technology |
+| 1990 | Launched the first-ever handheld personal computer |
+| 2000 | Introduced groundbreaking advancements in AI and robotics |
+| 2015 | Expansion into sustainable and eco-friendly product lines |
+
+## Company Overview
+
+At Contoso Electronics, we take pride in fostering a dynamic and inclusive workplace. Our dedicated team of experts collaborates to create innovative solutions that empower and connect people globally.
+
+### Core Values
+
+- **Innovation:** Constantly pushing the boundaries of technology.
+- **Diversity:** Embracing different perspectives for creative excellence.
+- **Sustainability:** Committed to eco-friendly practices in our products.
+
+## Vacation Perks
+
+We believe in work-life balance and understand the importance of well-deserved breaks. Our vacation perks are designed to help our employees recharge and return with renewed enthusiasm.
+
+| Vacation Tier | Duration | Additional Benefits |
+|---------------|----------|---------------------|
+| Standard | 2 weeks | Health and wellness stipend |
+| Senior | 4 weeks | Travel vouchers for a dream destination |
+| Executive | 6 weeks | Luxury resort getaway with family |
+
+## Employee Recognition
+
+Recognizing the hard work and dedication of our employees is at the core of our culture. Here are some ways we celebrate achievements:
+
+- Monthly "Innovator of the Month" awards
+- Annual gala with awards for outstanding contributions
+- Team-building retreats for high-performing departments
+
+## Join Us!
+
+Contoso Electronics is always on the lookout for talented individuals who share our passion for innovation. If you're ready to be part of a dynamic team shaping the future of technology, check out our [careers page](http://www.contoso.com) for exciting opportunities.
+
+[Learn more about Contoso Electronics!](http://www.contoso.com)
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/data/Contoso_Electronics_PerkPlus_Program.md b/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/data/Contoso_Electronics_PerkPlus_Program.md
new file mode 100644
index 0000000000..1d97d5117e
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/data/Contoso_Electronics_PerkPlus_Program.md
@@ -0,0 +1,36 @@
+# Contoso Electronics PerksPlus Program
+
+*Disclaimer: This document contains information generated using a language model (Azure OpenAI). The information contained in this document is only for demonstration purposes and does not reflect the opinions or beliefs of Microsoft. Microsoft makes no representations or warranties of any kind, express or implied, about the completeness, accuracy, reliability, suitability or availability with respect to the information contained in this document. All rights reserved to Microsoft.*
+
+## Overview
+Introducing PerksPlus - the ultimate benefits program designed to support the health and wellness of employees. With PerksPlus, employees have the opportunity to expense up to $1000 for fitness-related programs, making it easier and more affordable to maintain a healthy lifestyle. PerksPlus is not only designed to support employees' physical health, but also their mental health. Regular exercise has been shown to reduce stress, improve mood, and enhance overall well-being. With PerksPlus, employees can invest in their health and wellness, while enjoying the peace of mind that comes with knowing they are getting the support they need to lead a healthy life.
+What is Covered?
+
+PerksPlus covers a wide range of fitness activities, including but not limited to:
+* Gym memberships
+* Personal training sessions
+* Yoga and Pilates classes
+* Fitness equipment purchases
+* Sports team fees
+* Health retreats and spas
+* Outdoor adventure activities (such as rock climbing, hiking, and kayaking)
+* Group fitness classes (such as dance, martial arts, and cycling)
+* Virtual fitness programs (such as online yoga and workout classes)
+
+In addition to the wide range of fitness activities covered by PerksPlus, the program also covers a variety of lessons and experiences that promote health and wellness. Some of the lessons covered under PerksPlus include:
+* Skiing and snowboarding lessons
+* Scuba diving lessons
+* Surfing lessons
+* Horseback riding lessons
+
+These lessons provide employees with the opportunity to try new things, challenge themselves, and improve their physical skills. They are also a great way to relieve stress and have fun while staying active.
+
+With PerksPlus, employees can choose from a variety of fitness programs to suit their individual needs and preferences. Whether you're looking to improve your physical fitness, reduce stress, or just have some fun, PerksPlus has you covered.
+
+## What is Not Covered?
+In addition to the wide range of activities covered by PerksPlus, there is also a list of things that are not
+covered under the program. These include but are not limited to:
+* Non-fitness related expenses
+* Medical treatments and procedures
+* Travel expenses (unless related to a fitness program)
+* Food and supplements
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/data/Contoso_Electronics_Plan_Benefits.md b/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/data/Contoso_Electronics_Plan_Benefits.md
new file mode 100644
index 0000000000..9da5c6429d
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/data/Contoso_Electronics_Plan_Benefits.md
@@ -0,0 +1,37 @@
+# Contoso Electronics Plan and Benefit Packages
+
+*Disclaimer: This document contains information generated using a language model (Azure OpenAI). The information contained in this document is only for demonstration purposes and does not reflect the opinions or beliefs of Microsoft. Microsoft makes no representations or warranties of any kind, express or implied, about the completeness, accuracy, reliability, suitability or availability with respect to the information contained in this document. All rights reserved to Microsoft.*
+
+## Northwind Health Plus
+
+Northwind Health Plus is a comprehensive plan that provides comprehensive coverage for medical, vision, and dental services. This plan also offers prescription drug coverage, mental health and substance abuse coverage, and coverage for preventive care services. With Northwind Health Plus, you can choose from a variety of in-network providers, including primary care physicians, specialists, hospitals, and pharmacies.
+
+This plan also offers coverage for emergency services, both in-network and out-of-network.
+
+## Northwind Standard
+
+Northwind Standard is a basic plan that provides coverage for medical, vision, and dental services. This plan also offers coverage for preventive care services, as well as prescription drug coverage. With Northwind Standard, you can choose from a variety of in-network providers, including primary care physicians, specialists, hospitals, and pharmacies. This plan does not offer coverage for emergency services, mental health and substance abuse coverage, or out-of-network services.
+
+## Comparison of Plans
+
+Both plans offer coverage for routine physicals, well-child visits, immunizations, and other preventive care services. The plans also cover preventive care services such as mammograms, colonoscopies, and other cancer screenings.
+
+Northwind Health Plus offers more comprehensive coverage than Northwind Standard. This plan offers coverage for emergency services, both in-network and out-of-network, as well as mental health and substance abuse coverage. Northwind Standard does not offer coverage for emergency services, mental health and substance abuse coverage, or out-of-network services.
+
+Both plans offer coverage for prescription drugs. Northwind Health Plus offers a wider range of prescription drug coverage than Northwind Standard. Northwind Health Plus covers generic, brand-name, and specialty drugs, while Northwind Standard only covers generic and brand-name drugs.
+
+Both plans offer coverage for vision and dental services. Northwind Health Plus offers coverage for vision exams, glasses, and contact lenses, as well as dental exams, cleanings, and fillings. Northwind Standard only offers coverage for vision exams and glasses.
+
+Both plans offer coverage for medical services. Northwind Health Plus offers coverage for hospital stays, doctor visits, lab tests, and X-rays. Northwind Standard only offers coverage for doctor visits and lab tests.
+
+Northwind Health Plus is a comprehensive plan that offers more coverage than Northwind Standard. Northwind Health Plus offers coverage for emergency services, mental health and substance abuse coverage, and out-of-network services, while Northwind Standard does not. Northwind Health Plus also offers a wider range of prescription drug coverage than Northwind Standard. Both plans offer coverage for vision and dental services, as well as medical services.
+
+## Cost Comparison
+
+Contoso Electronics deducts the employee's portion of the healthcare cost from each paycheck. This means that the cost of the health insurance will be spread out over the course of the year, rather than being paid in one lump sum. The employee's portion of the cost will be calculated based on the selected health plan and the number of people covered by the insurance. The table below shows a cost comparison between the different health plans offered by Contoso Electronics
+
+| | Northwind Standard | NorthWind Health Plus |
+|---------------|----------|---------------------|
+| Employee Only | $45.00 | $55.00 |
+| Employee +1 | $65.00 | $71.00 |
+| Employee +2 or more | $78.00 | $89.00 |
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/delete.py.tpl b/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/delete.py.tpl
new file mode 100644
index 0000000000..50d1e92bfd
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/delete.py.tpl
@@ -0,0 +1,24 @@
+import os
+from azure.core.credentials import AzureKeyCredential
+from azure.search.documents.indexes import SearchIndexClient
+
+from dotenv import load_dotenv
+
+{{#enableTestToolByDefault}}
+load_dotenv(f'{os.getcwd()}/env/.env.testtool.user')
+{{/enableTestToolByDefault}}
+{{^enableTestToolByDefault}}
+load_dotenv(f'{os.getcwd()}/env/.env.local.user')
+{{/enableTestToolByDefault}}
+
+def delete_index(client: SearchIndexClient, name: str):
+ client.delete_index(name)
+ print(f"Index {name} deleted")
+
+index = 'contoso-electronics'
+search_api_key = os.getenv('SECRET_AZURE_SEARCH_KEY')
+search_api_endpoint = os.getenv('AZURE_SEARCH_ENDPOINT')
+credentials = AzureKeyCredential(search_api_key)
+
+search_index_client = SearchIndexClient(search_api_endpoint, credentials)
+delete_index(search_index_client, index)
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/get_data.py b/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/get_data.py
new file mode 100644
index 0000000000..719f7a5bfa
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/get_data.py
@@ -0,0 +1,39 @@
+import os
+
+async def get_doc_data(embeddings):
+ with open(f'{os.getcwd()}/src/indexers/data/Contoso_Electronics_PerkPlus_Program.md', 'r') as file:
+ raw_description1 = file.read()
+ doc1 = {
+ "docId": "1",
+ "docTitle": "Contoso_Electronics_PerkPlus_Program",
+ "description": raw_description1,
+ "descriptionVector": await get_embedding_vector(raw_description1, embeddings=embeddings),
+ }
+
+ with open(f'{os.getcwd()}/src/indexers/data/Contoso_Electronics_Company_Overview.md', 'r') as file:
+ raw_description2 = file.read()
+ doc2 = {
+ "docId": "2",
+ "docTitle": "Contoso_Electronics_Company_Overview",
+ "description": raw_description2,
+ "descriptionVector": await get_embedding_vector(raw_description2, embeddings=embeddings),
+ }
+
+ with open(f'{os.getcwd()}/src/indexers/data/Contoso_Electronics_Plan_Benefits.md', 'r') as file:
+ raw_description3 = file.read()
+ doc3 = {
+ "docId": "3",
+ "docTitle": "Contoso_Electronics_Plan_Benefits",
+ "description": raw_description3,
+ "descriptionVector": await get_embedding_vector(raw_description3, embeddings=embeddings),
+ }
+
+ return [doc1, doc2, doc3]
+
+
+async def get_embedding_vector(text: str, embeddings):
+ result = await embeddings.create_embeddings(text)
+ if (result.status != 'success' or not result.output):
+ raise Exception(f"Failed to generate embeddings for description: {text}")
+
+ return result.output[0]
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/setup.py.tpl b/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/setup.py.tpl
new file mode 100644
index 0000000000..719c69920d
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/src/indexers/setup.py.tpl
@@ -0,0 +1,103 @@
+import asyncio
+import os
+from dataclasses import dataclass
+from typing import List, Optional
+
+from azure.core.credentials import AzureKeyCredential
+from azure.search.documents import SearchClient
+from azure.search.documents.indexes import SearchIndexClient
+from azure.search.documents.indexes.models import (
+ SearchIndex,
+ SimpleField,
+ SearchableField,
+ SearchField,
+ SearchFieldDataType,
+ ComplexField,
+ CorsOptions,
+ VectorSearch,
+ VectorSearchProfile,
+ HnswAlgorithmConfiguration
+)
+{{#useAzureOpenAI}}
+from teams.ai.embeddings import AzureOpenAIEmbeddings, AzureOpenAIEmbeddingsOptions
+{{/useAzureOpenAI}}
+{{#useOpenAI}}
+from teams.ai.embeddings import OpenAIEmbeddings, OpenAIEmbeddingsOptions
+{{/useOpenAI}}
+
+from get_data import get_doc_data
+
+from dotenv import load_dotenv
+
+{{#enableTestToolByDefault}}
+load_dotenv(f'{os.getcwd()}/env/.env.testtool.user')
+{{/enableTestToolByDefault}}
+{{^enableTestToolByDefault}}
+load_dotenv(f'{os.getcwd()}/env/.env.local.user')
+{{/enableTestToolByDefault}}
+
+@dataclass
+class Doc:
+ docId: Optional[str] = None
+ docTitle: Optional[str] = None
+ description: Optional[str] = None
+ descriptionVector: Optional[List[float]] = None
+
+async def upsert_documents(client: SearchClient, documents: list[Doc]):
+ return client.merge_or_upload_documents(documents)
+
+async def create_index_if_not_exists(client: SearchIndexClient, name: str):
+ doc_index = SearchIndex(
+ name=name,
+ fields = [
+ SimpleField(name="docId", type=SearchFieldDataType.String, key=True),
+ SimpleField(name="docTitle", type=SearchFieldDataType.String),
+ SearchableField(name="description", type=SearchFieldDataType.String, searchable=True),
+ SearchField(name="descriptionVector", type=SearchFieldDataType.Collection(SearchFieldDataType.Single), searchable=True, vector_search_dimensions=1536, vector_search_profile_name='my-vector-config'),
+ ],
+ scoring_profiles=[],
+ cors_options=CorsOptions(allowed_origins=["*"]),
+ vector_search = VectorSearch(
+ profiles=[VectorSearchProfile(name="my-vector-config", algorithm_configuration_name="my-algorithms-config")],
+ algorithms=[HnswAlgorithmConfiguration(name="my-algorithms-config")],
+ )
+ )
+
+ client.create_or_update_index(doc_index)
+
+async def setup(search_api_key, search_api_endpoint):
+ index = 'contoso-electronics'
+
+ credentials = AzureKeyCredential(search_api_key)
+
+ search_index_client = SearchIndexClient(search_api_endpoint, credentials)
+ await create_index_if_not_exists(search_index_client, index)
+
+ print("Create index succeeded. If it does not exist, wait for 5 seconds...")
+ await asyncio.sleep(5)
+
+ search_client = SearchClient(search_api_endpoint, index, credentials)
+
+ {{#useAzureOpenAI}}
+ embeddings = AzureOpenAIEmbeddings(AzureOpenAIEmbeddingsOptions(
+ azure_api_key=os.getenv('SECRET_AZURE_OPENAI_API_KEY'),
+ azure_endpoint=os.getenv('AZURE_OPENAI_ENDPOINT'),
+ azure_deployment=os.getenv('AZURE_OPENAI_EMBEDDING_DEPLOYMENT')
+ ))
+ {{/useAzureOpenAI}}
+ {{#useOpenAI}}
+ embedding=OpenAIEmbeddings(OpenAIEmbeddingsOptions(
+ api_key=os.getenv('SECRET_OPENAI_API_KEY'),
+ model=os.getenv('OPENAI_EMBEDDING_DEPLOYMENT')
+ ))
+ {{/useOpenAI}}
+ data = await get_doc_data(embeddings=embeddings)
+ await upsert_documents(search_client, data)
+
+ print("Upload new documents succeeded. If they do not exist, wait for several seconds...")
+
+search_api_key = os.getenv('SECRET_AZURE_SEARCH_KEY')
+search_api_endpoint = os.getenv('AZURE_SEARCH_ENDPOINT')
+asyncio.run(setup(search_api_key, search_api_endpoint))
+print("setup finished")
+
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/src/prompts/chat/config.json b/templates/python/custom-copilot-rag-azure-ai-search/src/prompts/chat/config.json
new file mode 100644
index 0000000000..109caad3b4
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/src/prompts/chat/config.json
@@ -0,0 +1,24 @@
+{
+ "schema": 1.1,
+ "description": "Chat with Teams RAG",
+ "type": "completion",
+ "completion": {
+ "model": "gpt-35-turbo",
+ "completion_type": "chat",
+ "include_history": true,
+ "include_input": true,
+ "max_input_tokens": 4096,
+ "max_tokens": 1000,
+ "temperature": 0.9,
+ "top_p": 0.0,
+ "presence_penalty": 0.6,
+ "frequency_penalty": 0.0,
+ "stop_sequences": []
+ },
+ "augmentation": {
+ "augmentation_type": "none",
+ "data_sources": {
+ "azure-ai-search": 2500
+ }
+ }
+}
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-azure-ai-search/src/prompts/chat/skprompt.txt b/templates/python/custom-copilot-rag-azure-ai-search/src/prompts/chat/skprompt.txt
new file mode 100644
index 0000000000..789155ad1b
--- /dev/null
+++ b/templates/python/custom-copilot-rag-azure-ai-search/src/prompts/chat/skprompt.txt
@@ -0,0 +1,3 @@
+The following is a conversation with an AI assistant, who is an expert on answering questions over the given context.
+Responses should be in a short journalistic style with no more than 80 words.
+Use the context provided in the `{result} "
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-customize/src/prompts/chat/config.json b/templates/python/custom-copilot-rag-customize/src/prompts/chat/config.json
new file mode 100644
index 0000000000..8166d24f3d
--- /dev/null
+++ b/templates/python/custom-copilot-rag-customize/src/prompts/chat/config.json
@@ -0,0 +1,23 @@
+{
+ "schema": 1.1,
+ "description": "Chat with Teams RAG",
+ "type": "completion",
+ "completion": {
+ "completion_type": "chat",
+ "include_history": true,
+ "include_input": true,
+ "max_input_tokens": 4096,
+ "max_tokens": 1000,
+ "temperature": 0.9,
+ "top_p": 0.0,
+ "presence_penalty": 0.6,
+ "frequency_penalty": 0.0,
+ "stop_sequences": []
+ },
+ "augmentation": {
+ "augmentation_type": "none",
+ "data_sources": {
+ "local-search": 1200
+ }
+ }
+}
\ No newline at end of file
diff --git a/templates/python/custom-copilot-rag-customize/src/prompts/chat/skprompt.txt b/templates/python/custom-copilot-rag-customize/src/prompts/chat/skprompt.txt
new file mode 100644
index 0000000000..789155ad1b
--- /dev/null
+++ b/templates/python/custom-copilot-rag-customize/src/prompts/chat/skprompt.txt
@@ -0,0 +1,3 @@
+The following is a conversation with an AI assistant, who is an expert on answering questions over the given context.
+Responses should be in a short journalistic style with no more than 80 words.
+Use the context provided in the `} - A promise that resolves with the HTTP response containing the repair information.
+ */
+export async function repair(
+ req: HttpRequest,
+ context: InvocationContext
+): Promise {
+ context.log("HTTP trigger function processed a request.");
+
+ // Initialize response.
+ const res: HttpResponseInit = {
+ status: 200,
+ jsonBody: {
+ results: [],
+ },
+ };
+
+ // Get the assignedTo query parameter.
+ const assignedTo = req.query.get("assignedTo");
+
+ // If the assignedTo query parameter is not provided, return the response.
+ if (!assignedTo) {
+ return res;
+ }
+
+ // Filter the repair information by the assignedTo query parameter.
+ const repairs = repairRecords.filter((item) => {
+ const fullName = item.assignedTo.toLowerCase();
+ const query = assignedTo.trim().toLowerCase();
+ const [firstName, lastName] = fullName.split(" ");
+ return fullName === query || firstName === query || lastName === query;
+ });
+
+ // Return filtered repair records, or an empty array if no records were found.
+ res.jsonBody.results = repairs ?? [];
+ return res;
+}
+
+app.http("repair", {
+ methods: ["GET"],
+ authLevel: "anonymous",
+ handler: repair,
+});
diff --git a/templates/ts/api-message-extension-sso/src/repairsData.json b/templates/ts/api-message-extension-sso/src/repairsData.json
new file mode 100644
index 0000000000..fd4227e475
--- /dev/null
+++ b/templates/ts/api-message-extension-sso/src/repairsData.json
@@ -0,0 +1,50 @@
+[
+ {
+ "id": "1",
+ "title": "Oil change",
+ "description": "Need to drain the old engine oil and replace it with fresh oil to keep the engine lubricated and running smoothly.",
+ "assignedTo": "Karin Blair",
+ "date": "2023-05-23",
+ "image": "https://www.howmuchisit.org/wp-content/uploads/2011/01/oil-change.jpg"
+ },
+ {
+ "id": "2",
+ "title": "Brake repairs",
+ "description": "Conduct brake repairs, including replacing worn brake pads, resurfacing or replacing brake rotors, and repairing or replacing other components of the brake system.",
+ "assignedTo": "Issac Fielder",
+ "date": "2023-05-24",
+ "image": "https://upload.wikimedia.org/wikipedia/commons/7/71/Disk_brake_dsc03680.jpg"
+ },
+ {
+ "id": "3",
+ "title": "Tire service",
+ "description": "Rotate and replace tires, moving them from one position to another on the vehicle to ensure even wear and removing worn tires and installing new ones.",
+ "assignedTo": "Karin Blair",
+ "date": "2023-05-24",
+ "image": "https://th.bing.com/th/id/OIP.N64J4jmqmnbQc5dHvTm-QAHaE8?pid=ImgDet&rs=1"
+ },
+ {
+ "id": "4",
+ "title": "Battery replacement",
+ "description": "Remove the old battery and install a new one to ensure that the vehicle start reliably and the electrical systems function properly.",
+ "assignedTo": "Ashley McCarthy",
+ "date": "2023-05-25",
+ "image": "https://i.stack.imgur.com/4ftuj.jpg"
+ },
+ {
+ "id": "5",
+ "title": "Engine tune-up",
+ "description": "This can include a variety of services such as replacing spark plugs, air filters, and fuel filters to keep the engine running smoothly and efficiently.",
+ "assignedTo": "Karin Blair",
+ "date": "2023-05-28",
+ "image": "https://th.bing.com/th/id/R.e4c01dd9f232947e6a92beb0a36294a5?rik=P076LRx7J6Xnrg&riu=http%3a%2f%2fupload.wikimedia.org%2fwikipedia%2fcommons%2ff%2ff3%2f1990_300zx_engine.jpg&ehk=f8KyT78eO3b%2fBiXzh6BZr7ze7f56TWgPST%2bY%2f%2bHqhXQ%3d&risl=&pid=ImgRaw&r=0"
+ },
+ {
+ "id": "6",
+ "title": "Suspension and steering repairs",
+ "description": "This can include repairing or replacing components of the suspension and steering systems to ensure that the vehicle handles and rides smoothly.",
+ "assignedTo": "Daisy Phillips",
+ "date": "2023-05-29",
+ "image": "https://i.stack.imgur.com/4v5OI.jpg"
+ }
+]
diff --git a/templates/ts/api-message-extension-sso/teamsapp.local.yml.tpl b/templates/ts/api-message-extension-sso/teamsapp.local.yml.tpl
new file mode 100644
index 0000000000..33495c4121
--- /dev/null
+++ b/templates/ts/api-message-extension-sso/teamsapp.local.yml.tpl
@@ -0,0 +1,111 @@
+# yaml-language-server: $schema=https://aka.ms/teams-toolkit/1.0.0/yaml.schema.json
+# Visit https://aka.ms/teamsfx-v5.0-guide for details on this file
+# Visit https://aka.ms/teamsfx-actions for details on actions
+version: 1.0.0
+
+provision:
+ # Creates a new Microsoft Entra app to authenticate users if
+ # the environment variable that stores clientId is empty
+ - uses: aadApp/create
+ with:
+ # Note: when you run aadApp/update, the Microsoft Entra app name will be updated
+ # based on the definition in manifest. If you don't want to change the
+ # name, make sure the name in Microsoft Entra manifest is the same with the name
+ # defined here.
+ name: {{appName}}
+ # If the value is false, the action will not generate client secret for you
+ generateClientSecret: false
+ # Authenticate users with a Microsoft work or school account in your
+ # organization's Microsoft Entra tenant (for example, single tenant).
+ signInAudience: AzureADMyOrg
+ # Write the information of created resources into environment file for the
+ # specified environment variable(s).
+ writeToEnvironmentFile:
+ clientId: AAD_APP_CLIENT_ID
+ objectId: AAD_APP_OBJECT_ID
+ tenantId: AAD_APP_TENANT_ID
+ authority: AAD_APP_OAUTH_AUTHORITY
+ authorityHost: AAD_APP_OAUTH_AUTHORITY_HOST
+
+ # Creates a Teams app
+ - uses: teamsApp/create
+ with:
+ # Teams app name
+ name: {{appName}}${{APP_NAME_SUFFIX}}
+ # Write the information of created resources into environment file for
+ # the specified environment variable(s).
+ writeToEnvironmentFile:
+ teamsAppId: TEAMS_APP_ID
+
+ # Set required variables for local launch
+ - uses: script
+ with:
+ run:
+ echo "::set-teamsfx-env FUNC_NAME=repair";
+ echo "::set-teamsfx-env FUNC_ENDPOINT=http://localhost:7071";
+
+ # Apply the Microsoft Entra manifest to an existing Microsoft Entra app. Will use the object id in
+ # manifest file to determine which Microsoft Entra app to update.
+ - uses: aadApp/update
+ with:
+ # Relative path to this file. Environment variables in manifest will
+ # be replaced before apply to Microsoft Entra app
+ manifestPath: ./aad.manifest.json
+ outputFilePath: ./build/aad.manifest.${{TEAMSFX_ENV}}.json
+
+ # Validate using manifest schema
+ - uses: teamsApp/validateManifest
+ with:
+ # Path to manifest template
+ manifestPath: ./appPackage/manifest.json
+
+ # Build Teams app package with latest env value
+ - uses: teamsApp/zipAppPackage
+ with:
+ # Path to manifest template
+ manifestPath: ./appPackage/manifest.json
+ outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+ outputJsonPath: ./appPackage/build/manifest.${{TEAMSFX_ENV}}.json
+
+ # Validate app package using validation rules
+ - uses: teamsApp/validateAppPackage
+ with:
+ # Relative path to this file. This is the path for built zip file.
+ appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+
+ # Apply the Teams app manifest to an existing Teams app in
+ # Teams Developer Portal.
+ # Will use the app id in manifest file to determine which Teams app to update.
+ - uses: teamsApp/update
+ with:
+ # Relative path to this file. This is the path for built zip file.
+ appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+
+ # Extend your Teams app to Outlook and the Microsoft 365 app
+ - uses: teamsApp/extendToM365
+ with:
+ # Relative path to the build app package.
+ appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+ # Write the information of created resources into environment file for
+ # the specified environment variable(s).
+ writeToEnvironmentFile:
+ titleId: M365_TITLE_ID
+ appId: M365_APP_ID
+
+deploy:
+ # Install development tool(s)
+ - uses: devTool/install
+ with:
+ func:
+ version: ~4.0.5455
+ symlinkDir: ./devTools/func
+ # Write the information of installed development tool(s) into environment
+ # file for the specified environment variable(s).
+ writeToEnvironmentFile:
+ funcPath: FUNC_PATH
+
+ # Run npm command
+ - uses: cli/runNpmCommand
+ name: install dependencies
+ with:
+ args: install --no-audit
diff --git a/templates/ts/api-message-extension-sso/teamsapp.yml.tpl b/templates/ts/api-message-extension-sso/teamsapp.yml.tpl
new file mode 100644
index 0000000000..2548124de8
--- /dev/null
+++ b/templates/ts/api-message-extension-sso/teamsapp.yml.tpl
@@ -0,0 +1,178 @@
+# yaml-language-server: $schema=https://aka.ms/teams-toolkit/1.0.0/yaml.schema.json
+# Visit https://aka.ms/teamsfx-v5.0-guide for details on this file
+# Visit https://aka.ms/teamsfx-actions for details on actions
+version: 1.0.0
+
+environmentFolderPath: ./env
+
+# Triggered when 'teamsapp provision' is executed
+provision:
+ # Creates a new Microsoft Entra app to authenticate users if
+ # the environment variable that stores clientId is empty
+ - uses: aadApp/create
+ with:
+ # Note: when you run aadApp/update, the Microsoft Entra app name will be updated
+ # based on the definition in manifest. If you don't want to change the
+ # name, make sure the name in Microsoft Entra manifest is the same with the name
+ # defined here.
+ name: {{appName}}
+ # If the value is false, the action will not generate client secret for you
+ generateClientSecret: false
+ # Authenticate users with a Microsoft work or school account in your
+ # organization's Microsoft Entra tenant (for example, single tenant).
+ signInAudience: AzureADMyOrg
+ # Write the information of created resources into environment file for the
+ # specified environment variable(s).
+ writeToEnvironmentFile:
+ clientId: AAD_APP_CLIENT_ID
+ objectId: AAD_APP_OBJECT_ID
+ tenantId: AAD_APP_TENANT_ID
+ authority: AAD_APP_OAUTH_AUTHORITY
+ authorityHost: AAD_APP_OAUTH_AUTHORITY_HOST
+
+ # Creates a Teams app
+ - uses: teamsApp/create
+ with:
+ # Teams app name
+ name: {{appName}}${{APP_NAME_SUFFIX}}
+ # Write the information of created resources into environment file for
+ # the specified environment variable(s).
+ writeToEnvironmentFile:
+ teamsAppId: TEAMS_APP_ID
+
+ - uses: arm/deploy # Deploy given ARM templates parallelly.
+ with:
+ # AZURE_SUBSCRIPTION_ID is a built-in environment variable,
+ # if its value is empty, TeamsFx will prompt you to select a subscription.
+ # Referencing other environment variables with empty values
+ # will skip the subscription selection prompt.
+ subscriptionId: ${{AZURE_SUBSCRIPTION_ID}}
+ # AZURE_RESOURCE_GROUP_NAME is a built-in environment variable,
+ # if its value is empty, TeamsFx will prompt you to select or create one
+ # resource group.
+ # Referencing other environment variables with empty values
+ # will skip the resource group selection prompt.
+ resourceGroupName: ${{AZURE_RESOURCE_GROUP_NAME}}
+ templates:
+ - path: ./infra/azure.bicep # Relative path to this file
+ # Relative path to this yaml file.
+ # Placeholders will be replaced with corresponding environment
+ # variable before ARM deployment.
+ parameters: ./infra/azure.parameters.json
+ # Required when deploying ARM template
+ deploymentName: Create-resources-for-sme
+ # Teams Toolkit will download this bicep CLI version from github for you,
+ # will use bicep CLI in PATH if you remove this config.
+ bicepCliVersion: v0.9.1
+
+ # Apply the Microsoft Entra manifest to an existing Microsoft Entra app. Will use the object id in
+ # manifest file to determine which Microsoft Entra app to update.
+ - uses: aadApp/update
+ with:
+ # Relative path to this file. Environment variables in manifest will
+ # be replaced before apply to Microsoft Entra app
+ manifestPath: ./aad.manifest.json
+ outputFilePath: ./build/aad.manifest.${{TEAMSFX_ENV}}.json
+
+ # Validate using manifest schema
+ - uses: teamsApp/validateManifest
+ with:
+ # Path to manifest template
+ manifestPath: ./appPackage/manifest.json
+
+ # Build Teams app package with latest env value
+ - uses: teamsApp/zipAppPackage
+ with:
+ # Path to manifest template
+ manifestPath: ./appPackage/manifest.json
+ outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+ outputJsonPath: ./appPackage/build/manifest.${{TEAMSFX_ENV}}.json
+
+ # Validate app package using validation rules
+ - uses: teamsApp/validateAppPackage
+ with:
+ # Relative path to this file. This is the path for built zip file.
+ appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+
+ # Apply the Teams app manifest to an existing Teams app in
+ # Teams Developer Portal.
+ # Will use the app id in manifest file to determine which Teams app to update.
+ - uses: teamsApp/update
+ with:
+ # Relative path to this file. This is the path for built zip file.
+ appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+
+ # Extend your Teams app to Outlook and the Microsoft 365 app
+ - uses: teamsApp/extendToM365
+ with:
+ # Relative path to the build app package.
+ appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+ # Write the information of created resources into environment file for
+ # the specified environment variable(s).
+ writeToEnvironmentFile:
+ titleId: M365_TITLE_ID
+ appId: M365_APP_ID
+
+# Triggered when 'teamsapp deploy' is executed
+deploy:
+ # Run npm command
+ - uses: cli/runNpmCommand
+ name: install dependencies
+ with:
+ args: install
+
+ - uses: cli/runNpmCommand
+ name: build app
+ with:
+ args: run build --if-present
+
+ # Deploy your application to Azure Functions using the zip deploy feature.
+ # For additional details, see at https://aka.ms/zip-deploy-to-azure-functions
+ - uses: azureFunctions/zipDeploy
+ with:
+ # deploy base folder
+ artifactFolder: .
+ # Ignore file location, leave blank will ignore nothing
+ ignoreFile: .funcignore
+ # The resource id of the cloud resource to be deployed to.
+ # This key will be generated by arm/deploy action automatically.
+ # You can replace it with your existing Azure Resource id
+ # or add it to your environment variable file.
+ resourceId: ${{API_FUNCTION_RESOURCE_ID}}
+
+# Triggered when 'teamsapp publish' is executed
+publish:
+ # Validate using manifest schema
+ - uses: teamsApp/validateManifest
+ with:
+ # Path to manifest template
+ manifestPath: ./appPackage/manifest.json
+ # Build Teams app package with latest env value
+ - uses: teamsApp/zipAppPackage
+ with:
+ # Path to manifest template
+ manifestPath: ./appPackage/manifest.json
+ outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+ outputJsonPath: ./appPackage/build/manifest.${{TEAMSFX_ENV}}.json
+ # Validate app package using validation rules
+ - uses: teamsApp/validateAppPackage
+ with:
+ # Relative path to this file. This is the path for built zip file.
+ appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+ # Apply the Teams app manifest to an existing Teams app in
+ # Teams Developer Portal.
+ # Will use the app id in manifest file to determine which Teams app to update.
+ - uses: teamsApp/update
+ with:
+ # Relative path to this file. This is the path for built zip file.
+ appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+ # Publish the app to
+ # Teams Admin Center (https://admin.teams.microsoft.com/policies/manage-apps)
+ # for review and approval
+ - uses: teamsApp/publishAppPackage
+ with:
+ appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+ # Write the information of created resources into environment file for
+ # the specified environment variable(s).
+ writeToEnvironmentFile:
+ publishedAppId: TEAMS_APP_PUBLISHED_APP_ID
diff --git a/templates/ts/api-message-extension-sso/tsconfig.json b/templates/ts/api-message-extension-sso/tsconfig.json
new file mode 100644
index 0000000000..a8d695680c
--- /dev/null
+++ b/templates/ts/api-message-extension-sso/tsconfig.json
@@ -0,0 +1,13 @@
+{
+ "compilerOptions": {
+ "module": "commonjs",
+ "target": "es6",
+ "outDir": "dist",
+ "rootDir": ".",
+ "sourceMap": true,
+ "strict": false,
+ "resolveJsonModule": true,
+ "esModuleInterop": true,
+ "typeRoots": ["./node_modules/@types"]
+ }
+}
\ No newline at end of file
diff --git a/templates/ts/api-plugin-from-scratch/.vscode/launch.json b/templates/ts/api-plugin-from-scratch/.vscode/launch.json
index 9ad7575a0b..f5e8f96eb3 100644
--- a/templates/ts/api-plugin-from-scratch/.vscode/launch.json
+++ b/templates/ts/api-plugin-from-scratch/.vscode/launch.json
@@ -30,7 +30,7 @@
"internalConsoleOptions": "neverOpen"
},
{
- "name": "Preview in Teams (Edge)",
+ "name": "Preview in Copilot (Edge)",
"type": "msedge",
"request": "launch",
"url": "https://teams.microsoft.com?${account-hint}",
@@ -41,7 +41,7 @@
"internalConsoleOptions": "neverOpen"
},
{
- "name": "Preview in Teams (Chrome)",
+ "name": "Preview in Copilot (Chrome)",
"type": "chrome",
"request": "launch",
"url": "https://teams.microsoft.com?${account-hint}",
@@ -66,7 +66,7 @@
],
"compounds": [
{
- "name": "Debug in Teams (Edge)",
+ "name": "Debug in Copilot (Edge)",
"configurations": [
"Launch App in Teams (Edge)",
"Attach to Backend"
@@ -79,7 +79,7 @@
"stopAll": true
},
{
- "name": "Debug in Teams (Chrome)",
+ "name": "Debug in Copilot (Chrome)",
"configurations": [
"Launch App in Teams (Chrome)",
"Attach to Backend"
diff --git a/templates/ts/api-plugin-from-scratch/README.md b/templates/ts/api-plugin-from-scratch/README.md
index ca5478f8d0..6910063aad 100644
--- a/templates/ts/api-plugin-from-scratch/README.md
+++ b/templates/ts/api-plugin-from-scratch/README.md
@@ -1,8 +1,8 @@
-# Overview of API Plugin from New API Template
+# Overview of the Copilot Plugin template
-## Build an API Plugin from a new API with Azure Functions
+## Build a Copilot Plugin from a new API with Azure Functions
-This app template allows Teams to interact directly with third-party data, apps, and services, enhancing its capabilities and broadening its range of capabilities. It allows Teams to:
+This app template allows Microsoft Copilot for Microsoft 365 to interact directly with third-party data, apps, and services, enhancing its capabilities and broadening its range of capabilities. It allows Teams to:
- Retrieve real-time information, for example, latest news coverage on a product launch.
- Retrieve knowledge-based information, for example, my team’s design files in Figma.
@@ -16,6 +16,7 @@ This app template allows Teams to interact directly with third-party data, apps,
> - [Node.js](https://nodejs.org/), supported versions: 18
> - 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-cli)
+> - [Copilot for Microsoft 365 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.
@@ -30,16 +31,17 @@ This app template allows Teams to interact directly with third-party data, apps,
| `appPackage` | Templates for the Teams application manifest, the API specification and response template for API responses |
| `env` | Environment files |
| `infra` | Templates for provisioning Azure resources |
-| `src` | The source code for the repair API |
+| `src` | The source code for the repair API |
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/ai-plugin.json` | The manifest file for the API plugin. |
+| 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. |
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.
diff --git a/templates/js/api-plugin-from-scratch/appPackage/ai-plugin.json b/templates/ts/api-plugin-from-scratch/appPackage/ai-plugin.json.tpl
similarity index 96%
rename from templates/js/api-plugin-from-scratch/appPackage/ai-plugin.json
rename to templates/ts/api-plugin-from-scratch/appPackage/ai-plugin.json.tpl
index 7154b72c7c..fb11edba12 100644
--- a/templates/js/api-plugin-from-scratch/appPackage/ai-plugin.json
+++ b/templates/ts/api-plugin-from-scratch/appPackage/ai-plugin.json.tpl
@@ -1,6 +1,6 @@
{
"schema_version": "v2",
- "name_for_human": "Repair Search Plugin",
+ "name_for_human": "{{appName}}${{APP_NAME_SUFFIX}}",
"description_for_human": "Track your repair records",
"description_for_model": "Plugin for searching a repair list, you can search by who's assigned to the repair.",
"functions": [
diff --git a/templates/ts/api-plugin-from-scratch/appPackage/manifest.json.tpl b/templates/ts/api-plugin-from-scratch/appPackage/manifest.json.tpl
index 3ed557b7e7..9ebc549abb 100644
--- a/templates/ts/api-plugin-from-scratch/appPackage/manifest.json.tpl
+++ b/templates/ts/api-plugin-from-scratch/appPackage/manifest.json.tpl
@@ -23,7 +23,7 @@
"full": "The ultimate solution for hassle-free car maintenance management makes tracking and monitoring your car repair records a breeze."
},
"accentColor": "#FFFFFF",
- "apiPlugins": [
+ "plugins": [
{
"pluginFile": "ai-plugin.json"
}
diff --git a/templates/ts/command-and-response/package.json.tpl b/templates/ts/command-and-response/package.json.tpl
index 71eec10a05..d688d97f2b 100644
--- a/templates/ts/command-and-response/package.json.tpl
+++ b/templates/ts/command-and-response/package.json.tpl
@@ -23,7 +23,7 @@
"url": "https://github.com"
},
"dependencies": {
- "@microsoft/teamsfx": "^2.2.0",
+ "@microsoft/teamsfx": "^2.3.1",
"botbuilder": "^4.20.0",
"restify": "^10.0.0"
},
diff --git a/templates/ts/command-and-response/teamsapp.local.yml.tpl b/templates/ts/command-and-response/teamsapp.local.yml.tpl
index a886dfe614..5c51cea38d 100644
--- a/templates/ts/command-and-response/teamsapp.local.yml.tpl
+++ b/templates/ts/command-and-response/teamsapp.local.yml.tpl
@@ -15,15 +15,19 @@ provision:
teamsAppId: TEAMS_APP_ID
# Create or reuse an existing Microsoft Entra application for bot.
- - uses: botAadApp/create
+ - uses: aadApp/create
with:
# The Microsoft Entra application's display name
name: {{appName}}${{APP_NAME_SUFFIX}}
+ generateClientSecret: true
+ signInAudience: AzureADMultipleOrgs
writeToEnvironmentFile:
# The Microsoft Entra application's client id created for bot.
- botId: BOT_ID
+ clientId: BOT_ID
# The Microsoft Entra application's client secret created for bot.
- botPassword: SECRET_BOT_PASSWORD
+ clientSecret: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's object id created for bot.
+ objectId: BOT_OBJECT_ID
# Create or update the bot registration on dev.botframework.com
- uses: botFramework/create
diff --git a/templates/ts/command-and-response/teamsapp.yml.tpl b/templates/ts/command-and-response/teamsapp.yml.tpl
index e30197f678..bc4c8c97be 100644
--- a/templates/ts/command-and-response/teamsapp.yml.tpl
+++ b/templates/ts/command-and-response/teamsapp.yml.tpl
@@ -18,15 +18,19 @@ provision:
teamsAppId: TEAMS_APP_ID
# Create or reuse an existing Microsoft Entra application for bot.
- - uses: botAadApp/create
+ - uses: aadApp/create
with:
# The Microsoft Entra application's display name
name: {{appName}}${{APP_NAME_SUFFIX}}
+ generateClientSecret: true
+ signInAudience: AzureADMultipleOrgs
writeToEnvironmentFile:
# The Microsoft Entra application's client id created for bot.
- botId: BOT_ID
+ clientId: BOT_ID
# The Microsoft Entra application's client secret created for bot.
- botPassword: SECRET_BOT_PASSWORD
+ clientSecret: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's object id created for bot.
+ objectId: BOT_OBJECT_ID
- uses: arm/deploy # Deploy given ARM templates parallelly.
with:
diff --git a/templates/ts/copilot-plugin-from-scratch-api-key/appPackage/apiSpecificationFile/repair.yml b/templates/ts/copilot-plugin-from-scratch-api-key/appPackage/apiSpecificationFile/repair.yml
index 28b61078db..32206ea0c3 100644
--- a/templates/ts/copilot-plugin-from-scratch-api-key/appPackage/apiSpecificationFile/repair.yml
+++ b/templates/ts/copilot-plugin-from-scratch-api-key/appPackage/apiSpecificationFile/repair.yml
@@ -8,10 +8,9 @@ servers:
description: The repair api server
components:
securitySchemes:
- ApiKeyAuth:
- type: apiKey
- in: header
- name: x-api-key
+ apiKey:
+ type: http
+ scheme: bearer
paths:
/repair:
get:
@@ -26,7 +25,7 @@ paths:
type: string
required: false
security:
- - ApiKeyAuth: []
+ - apiKey: []
responses:
'200':
description: A list of repairs
diff --git a/templates/ts/copilot-plugin-from-scratch-api-key/appPackage/manifest.json.tpl b/templates/ts/copilot-plugin-from-scratch-api-key/appPackage/manifest.json.tpl
index 6b7bc23629..2de42871af 100644
--- a/templates/ts/copilot-plugin-from-scratch-api-key/appPackage/manifest.json.tpl
+++ b/templates/ts/copilot-plugin-from-scratch-api-key/appPackage/manifest.json.tpl
@@ -50,7 +50,7 @@
"authorization": {
"authType": "apiSecretServiceAuth",
"apiSecretServiceAuthConfiguration": {
- "apiSecretRegistrationId": "${{X_API_KEY_REGISTRATION_ID}}"
+ "apiSecretRegistrationId": "${{APIKEY_REGISTRATION_ID}}"
}
}
}
diff --git a/templates/ts/copilot-plugin-from-scratch-api-key/src/functions/repair.ts b/templates/ts/copilot-plugin-from-scratch-api-key/src/functions/repair.ts
index 36b1317c8f..a1ccdebdbe 100644
--- a/templates/ts/copilot-plugin-from-scratch-api-key/src/functions/repair.ts
+++ b/templates/ts/copilot-plugin-from-scratch-api-key/src/functions/repair.ts
@@ -66,7 +66,7 @@ export async function repair(
* @returns {boolean} - True if the request is authorized, false otherwise.
*/
function isApiKeyValid(req: HttpRequest): boolean {
- const apiKey = req.headers.get("x-api-key");
+ const apiKey = req.headers.get("Authorization")?.replace("Bearer ", "").trim();
return apiKey === process.env.API_KEY;
}
diff --git a/templates/ts/copilot-plugin-from-scratch-api-key/teamsapp.local.yml.tpl b/templates/ts/copilot-plugin-from-scratch-api-key/teamsapp.local.yml.tpl
index 3ed2e96e6f..92a108e9ee 100644
--- a/templates/ts/copilot-plugin-from-scratch-api-key/teamsapp.local.yml.tpl
+++ b/templates/ts/copilot-plugin-from-scratch-api-key/teamsapp.local.yml.tpl
@@ -1,7 +1,7 @@
-# yaml-language-server: $schema=https://aka.ms/teams-toolkit/v1.4/yaml.schema.json
+# yaml-language-server: $schema=https://aka.ms/teams-toolkit/v1.5/yaml.schema.json
# Visit https://aka.ms/teamsfx-v5.0-guide for details on this file
# Visit https://aka.ms/teamsfx-actions for details on actions
-version: v1.4
+version: v1.5
provision:
# Creates a Teams app
@@ -25,7 +25,7 @@ provision:
- uses: apiKey/register
with:
# Name of the API Key
- name: x-api-key
+ name: apiKey
# Value of the API Key
primaryClientSecret: ${{SECRET_API_KEY}}
# Teams app ID
@@ -35,7 +35,18 @@ provision:
# Write the registration information of API Key into environment file for
# the specified environment variable(s).
writeToEnvironmentFile:
- registrationId: X_API_KEY_REGISTRATION_ID
+ registrationId: APIKEY_REGISTRATION_ID
+
+ # Update API KEY
+ - uses: apiKey/update
+ with:
+ # Name of the API Key
+ name: apiKey
+ # Teams app ID
+ appId: ${{TEAMS_APP_ID}}
+ # Path to OpenAPI description document
+ apiSpecPath: ./appPackage/apiSpecificationFile/repair.yml
+ registrationId: ${{APIKEY_REGISTRATION_ID}}
# Validate using manifest schema
- uses: teamsApp/validateManifest
diff --git a/templates/ts/copilot-plugin-from-scratch-api-key/teamsapp.yml.tpl b/templates/ts/copilot-plugin-from-scratch-api-key/teamsapp.yml.tpl
index 05995a77bf..dbda5dd31e 100644
--- a/templates/ts/copilot-plugin-from-scratch-api-key/teamsapp.yml.tpl
+++ b/templates/ts/copilot-plugin-from-scratch-api-key/teamsapp.yml.tpl
@@ -1,7 +1,7 @@
-# yaml-language-server: $schema=https://aka.ms/teams-toolkit/v1.4/yaml.schema.json
+# yaml-language-server: $schema=https://aka.ms/teams-toolkit/v1.5/yaml.schema.json
# Visit https://aka.ms/teamsfx-v5.0-guide for details on this file
# Visit https://aka.ms/teamsfx-actions for details on actions
-version: v1.4
+version: v1.5
environmentFolderPath: ./env
@@ -46,7 +46,7 @@ provision:
- uses: apiKey/register
with:
# Name of the API Key
- name: x-api-key
+ name: apiKey
# Value of the API Key
primaryClientSecret: ${{SECRET_API_KEY}}
# Teams app ID
@@ -56,7 +56,18 @@ provision:
# Write the registration information of API Key into environment file for
# the specified environment variable(s).
writeToEnvironmentFile:
- registrationId: X_API_KEY_REGISTRATION_ID
+ registrationId: APIKEY_REGISTRATION_ID
+
+ # Update API KEY
+ - uses: apiKey/update
+ with:
+ # Name of the API Key
+ name: apiKey
+ # Teams app ID
+ appId: ${{TEAMS_APP_ID}}
+ # Path to OpenAPI description document
+ apiSpecPath: ./appPackage/apiSpecificationFile/repair.yml
+ registrationId: ${{APIKEY_REGISTRATION_ID}}
# Validate using manifest schema
- uses: teamsApp/validateManifest
diff --git a/templates/ts/custom-copilot-assistant-assistants-api/package.json.tpl b/templates/ts/custom-copilot-assistant-assistants-api/package.json.tpl
index 4da8a2bfde..febe966f0b 100644
--- a/templates/ts/custom-copilot-assistant-assistants-api/package.json.tpl
+++ b/templates/ts/custom-copilot-assistant-assistants-api/package.json.tpl
@@ -29,6 +29,7 @@
"dependencies": {
"@microsoft/teams-ai": "^1.1.0",
"botbuilder": "^4.20.0",
+ "openai": "~4.28.4",
"restify": "^10.0.0"
},
"devDependencies": {
diff --git a/templates/ts/custom-copilot-assistant-assistants-api/teamsapp.local.yml.tpl b/templates/ts/custom-copilot-assistant-assistants-api/teamsapp.local.yml.tpl
index 31f3eccff7..632d4bfd69 100644
--- a/templates/ts/custom-copilot-assistant-assistants-api/teamsapp.local.yml.tpl
+++ b/templates/ts/custom-copilot-assistant-assistants-api/teamsapp.local.yml.tpl
@@ -15,15 +15,19 @@ provision:
teamsAppId: TEAMS_APP_ID
# Create or reuse an existing Microsoft Entra application for bot.
- - uses: botAadApp/create
+ - uses: aadApp/create
with:
# The Microsoft Entra application's display name
name: {{appName}}${{APP_NAME_SUFFIX}}
+ generateClientSecret: true
+ signInAudience: AzureADMultipleOrgs
writeToEnvironmentFile:
# The Microsoft Entra application's client id created for bot.
- botId: BOT_ID
+ clientId: BOT_ID
# The Microsoft Entra application's client secret created for bot.
- botPassword: SECRET_BOT_PASSWORD
+ clientSecret: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's object id created for bot.
+ objectId: BOT_OBJECT_ID
# Create or update the bot registration on dev.botframework.com
- uses: botFramework/create
diff --git a/templates/ts/custom-copilot-assistant-assistants-api/teamsapp.yml.tpl b/templates/ts/custom-copilot-assistant-assistants-api/teamsapp.yml.tpl
index ad88b620cc..b253e3db1b 100644
--- a/templates/ts/custom-copilot-assistant-assistants-api/teamsapp.yml.tpl
+++ b/templates/ts/custom-copilot-assistant-assistants-api/teamsapp.yml.tpl
@@ -18,15 +18,19 @@ provision:
teamsAppId: TEAMS_APP_ID
# Create or reuse an existing Microsoft Entra application for bot.
- - uses: botAadApp/create
+ - uses: aadApp/create
with:
# The Microsoft Entra application's display name
name: {{appName}}${{APP_NAME_SUFFIX}}
+ generateClientSecret: true
+ signInAudience: AzureADMultipleOrgs
writeToEnvironmentFile:
# The Microsoft Entra application's client id created for bot.
- botId: BOT_ID
+ clientId: BOT_ID
# The Microsoft Entra application's client secret created for bot.
- botPassword: SECRET_BOT_PASSWORD
+ clientSecret: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's object id created for bot.
+ objectId: BOT_OBJECT_ID
- uses: arm/deploy # Deploy given ARM templates parallelly.
with:
diff --git a/templates/ts/custom-copilot-assistant-new/README.md.tpl b/templates/ts/custom-copilot-assistant-new/README.md.tpl
index 008a25563b..fc2db97f92 100644
--- a/templates/ts/custom-copilot-assistant-new/README.md.tpl
+++ b/templates/ts/custom-copilot-assistant-new/README.md.tpl
@@ -33,7 +33,7 @@ It showcases how to build an AI agent in Teams capable of chatting with users an
1. In file *env/.env.testtool.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY=`.
{{/useOpenAI}}
{{#useAzureOpenAI}}
-1. In file *env/.env.testtool.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_ENDPOINT=`, endpoint `AZURE_OPENAI_ENDPOINT=`, and deployment name `AZURE_OPENAI_DEPLOYMENT_NAME=`.
+1. In file *env/.env.testtool.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_API_KEY=`, endpoint `AZURE_OPENAI_ENDPOINT=`, and deployment name `AZURE_OPENAI_DEPLOYMENT_NAME=`.
{{/useAzureOpenAI}}
1. Press F5 to start debugging which launches your app in Teams App Test Tool using a web browser. Select `Debug in Test Tool (Preview)`.
1. You can send any message to get a response from the bot.
@@ -48,7 +48,7 @@ It showcases how to build an AI agent in Teams capable of chatting with users an
1. In file *env/.env.local.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY=`.
{{/useOpenAI}}
{{#useAzureOpenAI}}
-1. In file *env/.env.local.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_ENDPOINT=`, endpoint `AZURE_OPENAI_ENDPOINT=`, and deployment name `AZURE_OPENAI_DEPLOYMENT_NAME=`.
+1. In file *env/.env.local.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_API_KEY=`, endpoint `AZURE_OPENAI_ENDPOINT=`, and deployment name `AZURE_OPENAI_DEPLOYMENT_NAME=`.
{{/useAzureOpenAI}}
1. Press F5 to start debugging which launches your app in Teams using a web browser. Select `Debug in Teams (Edge)` or `Debug in Teams (Chrome)`.
1. When Teams launches in the browser, select the Add button in the dialog to install your app to Teams.
diff --git a/templates/ts/custom-copilot-assistant-new/package.json.tpl b/templates/ts/custom-copilot-assistant-new/package.json.tpl
index 5639b594a6..20608e7df8 100644
--- a/templates/ts/custom-copilot-assistant-new/package.json.tpl
+++ b/templates/ts/custom-copilot-assistant-new/package.json.tpl
@@ -28,6 +28,7 @@
"dependencies": {
"@microsoft/teams-ai": "^1.1.0",
"botbuilder": "^4.20.0",
+ "openai": "~4.28.4",
"restify": "^10.0.0"
},
"devDependencies": {
diff --git a/templates/ts/custom-copilot-assistant-new/teamsapp.local.yml.tpl b/templates/ts/custom-copilot-assistant-new/teamsapp.local.yml.tpl
index 86a5368f1f..1676b1c6f7 100644
--- a/templates/ts/custom-copilot-assistant-new/teamsapp.local.yml.tpl
+++ b/templates/ts/custom-copilot-assistant-new/teamsapp.local.yml.tpl
@@ -15,15 +15,19 @@ provision:
teamsAppId: TEAMS_APP_ID
# Create or reuse an existing Microsoft Entra application for bot.
- - uses: botAadApp/create
+ - uses: aadApp/create
with:
# The Microsoft Entra application's display name
name: {{appName}}${{APP_NAME_SUFFIX}}
+ generateClientSecret: true
+ signInAudience: AzureADMultipleOrgs
writeToEnvironmentFile:
# The Microsoft Entra application's client id created for bot.
- botId: BOT_ID
+ clientId: BOT_ID
# The Microsoft Entra application's client secret created for bot.
- botPassword: SECRET_BOT_PASSWORD
+ clientSecret: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's object id created for bot.
+ objectId: BOT_OBJECT_ID
# Create or update the bot registration on dev.botframework.com
- uses: botFramework/create
diff --git a/templates/ts/custom-copilot-assistant-new/teamsapp.yml.tpl b/templates/ts/custom-copilot-assistant-new/teamsapp.yml.tpl
index ad88b620cc..b253e3db1b 100644
--- a/templates/ts/custom-copilot-assistant-new/teamsapp.yml.tpl
+++ b/templates/ts/custom-copilot-assistant-new/teamsapp.yml.tpl
@@ -18,15 +18,19 @@ provision:
teamsAppId: TEAMS_APP_ID
# Create or reuse an existing Microsoft Entra application for bot.
- - uses: botAadApp/create
+ - uses: aadApp/create
with:
# The Microsoft Entra application's display name
name: {{appName}}${{APP_NAME_SUFFIX}}
+ generateClientSecret: true
+ signInAudience: AzureADMultipleOrgs
writeToEnvironmentFile:
# The Microsoft Entra application's client id created for bot.
- botId: BOT_ID
+ clientId: BOT_ID
# The Microsoft Entra application's client secret created for bot.
- botPassword: SECRET_BOT_PASSWORD
+ clientSecret: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's object id created for bot.
+ objectId: BOT_OBJECT_ID
- uses: arm/deploy # Deploy given ARM templates parallelly.
with:
diff --git a/templates/ts/custom-copilot-basic/README.md.tpl b/templates/ts/custom-copilot-basic/README.md.tpl
index 914de5bba6..c933104000 100644
--- a/templates/ts/custom-copilot-basic/README.md.tpl
+++ b/templates/ts/custom-copilot-basic/README.md.tpl
@@ -16,13 +16,13 @@ The app template is built using the Teams AI library, which provides the capabil
>
> To run the Basic AI Chatbot template in your local dev machine, you will need:
>
-> - [Node.js](https://nodejs.org/), supported versions: 16, 18
+> - [Node.js](https://nodejs.org/), supported versions: 16, 18.
{{^enableTestToolByDefault}}
-> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts)
+> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts).
{{/enableTestToolByDefault}}
-> - [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)
+> - [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) latest version or [Teams Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli).
{{#useOpenAI}}
-> - An account with [OpenAI](https://platform.openai.com/)
+> - An account with [OpenAI](https://platform.openai.com/).
{{/useOpenAI}}
{{#useAzureOpenAI}}
> - Prepare your own [Azure OpenAI](https://aka.ms/oai/access) resource.
@@ -34,7 +34,7 @@ The app template is built using the Teams AI library, which provides the capabil
1. In file *env/.env.testtool.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY=`.
{{/useOpenAI}}
{{#useAzureOpenAI}}
-1. In file *env/.env.testtool.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_ENDPOINT=`, endpoint `AZURE_OPENAI_ENDPOINT=`, and deployment name `AZURE_OPENAI_DEPLOYMENT_NAME=`.
+1. In file *env/.env.testtool.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_API_KEY=`, endpoint `AZURE_OPENAI_ENDPOINT=`, and deployment name `AZURE_OPENAI_DEPLOYMENT_NAME=`.
{{/useAzureOpenAI}}
1. Press F5 to start debugging which launches your app in Teams App Test Tool using a web browser. Select `Debug in Test Tool (Preview)`.
1. You can send any message to get a response from the bot.
@@ -49,7 +49,7 @@ The app template is built using the Teams AI library, which provides the capabil
1. In file *env/.env.local.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY=`.
{{/useOpenAI}}
{{#useAzureOpenAI}}
-1. In file *env/.env.local.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_ENDPOINT=`, endpoint `AZURE_OPENAI_ENDPOINT=`, and deployment name `AZURE_OPENAI_DEPLOYMENT_NAME=`.
+1. In file *env/.env.local.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_API_KEY=`, endpoint `AZURE_OPENAI_ENDPOINT=`, and deployment name `AZURE_OPENAI_DEPLOYMENT_NAME=`.
{{/useAzureOpenAI}}
1. Press F5 to start debugging which launches your app in Teams using a web browser. Select `Debug in Teams (Edge)` or `Debug in Teams (Chrome)`.
1. When Teams launches in the browser, select the Add button in the dialog to install your app to Teams.
diff --git a/templates/ts/custom-copilot-basic/package.json.tpl b/templates/ts/custom-copilot-basic/package.json.tpl
index 5639b594a6..20608e7df8 100644
--- a/templates/ts/custom-copilot-basic/package.json.tpl
+++ b/templates/ts/custom-copilot-basic/package.json.tpl
@@ -28,6 +28,7 @@
"dependencies": {
"@microsoft/teams-ai": "^1.1.0",
"botbuilder": "^4.20.0",
+ "openai": "~4.28.4",
"restify": "^10.0.0"
},
"devDependencies": {
diff --git a/templates/ts/custom-copilot-basic/teamsapp.local.yml.tpl b/templates/ts/custom-copilot-basic/teamsapp.local.yml.tpl
index 86a5368f1f..1676b1c6f7 100644
--- a/templates/ts/custom-copilot-basic/teamsapp.local.yml.tpl
+++ b/templates/ts/custom-copilot-basic/teamsapp.local.yml.tpl
@@ -15,15 +15,19 @@ provision:
teamsAppId: TEAMS_APP_ID
# Create or reuse an existing Microsoft Entra application for bot.
- - uses: botAadApp/create
+ - uses: aadApp/create
with:
# The Microsoft Entra application's display name
name: {{appName}}${{APP_NAME_SUFFIX}}
+ generateClientSecret: true
+ signInAudience: AzureADMultipleOrgs
writeToEnvironmentFile:
# The Microsoft Entra application's client id created for bot.
- botId: BOT_ID
+ clientId: BOT_ID
# The Microsoft Entra application's client secret created for bot.
- botPassword: SECRET_BOT_PASSWORD
+ clientSecret: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's object id created for bot.
+ objectId: BOT_OBJECT_ID
# Create or update the bot registration on dev.botframework.com
- uses: botFramework/create
diff --git a/templates/ts/custom-copilot-basic/teamsapp.yml.tpl b/templates/ts/custom-copilot-basic/teamsapp.yml.tpl
index ad88b620cc..b253e3db1b 100644
--- a/templates/ts/custom-copilot-basic/teamsapp.yml.tpl
+++ b/templates/ts/custom-copilot-basic/teamsapp.yml.tpl
@@ -18,15 +18,19 @@ provision:
teamsAppId: TEAMS_APP_ID
# Create or reuse an existing Microsoft Entra application for bot.
- - uses: botAadApp/create
+ - uses: aadApp/create
with:
# The Microsoft Entra application's display name
name: {{appName}}${{APP_NAME_SUFFIX}}
+ generateClientSecret: true
+ signInAudience: AzureADMultipleOrgs
writeToEnvironmentFile:
# The Microsoft Entra application's client id created for bot.
- botId: BOT_ID
+ clientId: BOT_ID
# The Microsoft Entra application's client secret created for bot.
- botPassword: SECRET_BOT_PASSWORD
+ clientSecret: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's object id created for bot.
+ objectId: BOT_OBJECT_ID
- uses: arm/deploy # Deploy given ARM templates parallelly.
with:
diff --git a/templates/ts/custom-copilot-rag-custom-api/README.md.tpl b/templates/ts/custom-copilot-rag-custom-api/README.md.tpl
index a158111b63..b0c9a92d85 100644
--- a/templates/ts/custom-copilot-rag-custom-api/README.md.tpl
+++ b/templates/ts/custom-copilot-rag-custom-api/README.md.tpl
@@ -1,20 +1,20 @@
-# Overview of the Basic AI Chatbot template
+# Overview of the Custom Copilot from Custom API template
-This template showcases a bot app that responds to user questions like ChatGPT. This enables your users to talk with the AI bot in Teams.
+This template showcases an AI-powered intelligent chatbot that can understand natural language to invoke the API defined in the OpenAPI description document.
The app template is built using the Teams AI library, which provides the capabilities to build AI-based Teams applications.
-
-- [Overview of the Basic AI Chatbot template](#overview-of-the-basic-ai-chatbot-template)
- - [Get started with the Basic AI Chatbot template](#get-started-with-the-basic-ai-chatbot-template)
+
+- [Overview of the Custom Copilot from Custom API template](#overview-of-the-basic-ai-chatbot-template)
+ - [Get started with the Custom Copilot from Custom API template](#get-started-with-the-basic-ai-chatbot-template)
- [What's included in the template](#whats-included-in-the-template)
- - [Extend the Basic AI Chatbot template with more AI capabilities](#extend-the-basic-ai-chatbot-template-with-more-ai-capabilities)
+ - [Extend the Custom Copilot from Custom API template with more APIs](#extend-the-custom-copilot-from-custom-api-template-with-more-apis)
- [Additional information and references](#additional-information-and-references)
-## Get started with the Basic AI Chatbot template
+## Get started with the Custom Copilot from Custom API template
> **Prerequisites**
>
-> To run the Basic AI Chatbot template in your local dev machine, you will need:
+> To run the Custom Copilot from Custom API template in your local dev machine, you will need:
>
> - [Node.js](https://nodejs.org/), supported versions: 16, 18
{{^enableTestToolByDefault}}
@@ -34,15 +34,14 @@ The app template is built using the Teams AI library, which provides the capabil
1. In file *env/.env.testtool.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY=`.
{{/useOpenAI}}
{{#useAzureOpenAI}}
-1. In file *env/.env.testtool.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_ENDPOINT=` and endpoint `SECRET_AZURE_OPENAI_ENDPOINT=`.
-1. In `src/app/app.ts`, update `azureDefaultDeployment` to your own model deployment name.
+1. In file *env/.env.testtool.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_ENDPOINT=`, endpoint `SECRET_AZURE_OPENAI_ENDPOINT=` and deployment name `AZURE_OPENAI_DEPLOYMENT=`.
{{/useAzureOpenAI}}
1. Press F5 to start debugging which launches your app in Teams App Test Tool using a web browser. Select `Debug in Test Tool (Preview)`.
1. You can send any message to get a response from the bot.
**Congratulations**! You are running an application that can now interact with users in Teams App Test Tool:
-
+
{{/enableTestToolByDefault}}
{{^enableTestToolByDefault}}
1. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't yet.
@@ -50,7 +49,7 @@ The app template is built using the Teams AI library, which provides the capabil
1. In file *env/.env.local.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY=`.
{{/useOpenAI}}
{{#useAzureOpenAI}}
-1. In file *env/.env.local.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_ENDPOINT=` and endpoint `SECRET_AZURE_OPENAI_ENDPOINT=`.
+1. In file *env/.env.local.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_ENDPOINT=`, endpoint `SECRET_AZURE_OPENAI_ENDPOINT= and deployment name `AZURE_OPENAI_DEPLOYMENT=`.
{{/useAzureOpenAI}}
1. Press F5 to start debugging which launches your app in Teams using a web browser. Select `Debug in Teams (Edge)` or `Debug in Teams (Chrome)`.
1. When Teams launches in the browser, select the Add button in the dialog to install your app to Teams.
@@ -58,7 +57,7 @@ The app template is built using the Teams AI library, which provides the capabil
**Congratulations**! You are running an application that can now interact with users in Teams:
-
+
{{/enableTestToolByDefault}}
## What's included in the template
@@ -67,6 +66,7 @@ The app template is built using the Teams AI library, which provides the capabil
| - | - |
| `.vscode` | VSCode files for debugging |
| `appPackage` | Templates for the Teams application manifest |
+| `appPackage/apiSpecificationFile` | Generated API spec file |
| `env` | Environment files |
| `infra` | Templates for provisioning Azure resources |
| `src` | The source code for the application |
@@ -75,12 +75,14 @@ The following files can be customized and demonstrate an example implementation
| File | Contents |
| - | - |
-|`src/index.ts`| Sets up the bot app server.|
-|`src/adapter.ts`| Sets up the bot adapter.|
-|`src/config.ts`| Defines the environment variables.|
+|`src/index.js`| Sets up the bot app server.|
+|`src/adapter.js`| Sets up the bot adapter.|
+|`src/config.js`| Defines the environment variables.|
|`src/prompts/chat/skprompt.txt`| Defines the prompt.|
|`src/prompts/chat/config.json`| Configures the prompt.|
-|`src/app/app.ts`| Handles business logics for the Basic AI Chatbot.|
+|`src.primpts/chat/actions.json`| List of available actions.|
+|`src/app/app.js`| Handles business logics for the AI bot.|
+|`src/app/utility.js`| Utility methods for the AI bot.|
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.
@@ -90,9 +92,72 @@ The following are Teams Toolkit specific project files. You can [visit a complet
|`teamsapp.local.yml`|This overrides `teamsapp.yml` with actions that enable local execution and debugging.|
|`teamsapp.testtool.yml`| This overrides `teamsapp.yml` with actions that enable local execution and debugging in Teams App Test Tool.|
-## Extend the Basic AI Chatbot template with more AI capabilities
-
-You can follow [Basic AI Chatbot in Teams](https://aka.ms/teamsfx-basic-ai-chatbot) to extend the Basic AI Chatbot template with more AI capabilities.
+## Extend the Custom Copilot from Custom API template with more APIs
+
+You can follow the following steps to extend the Custom Copilot from Custom API template with more APIs.
+
+1. Update `./appPackage/apiSpecificationFile/openapi.*`
+
+ Copy corresponding part of the API you want to add from your spec, and append to `./appPackage/apiSpecificationFile/openapi.*`.
+
+1. Update `./src/prompts/chat/actions.json`
+
+ Fill necessary info and properties for path, query and/or body for the API in the following object, and add it in the array in `./src/prompts/chat/actions.json`.
+ ```
+ {
+ "name": "${{YOUR-API-NAME}}",
+ "description": "${{YOUR-API-DESCRIPTION}}",
+ "parameters": {
+ "type": "object",
+ "properties": {
+ "query": {
+ "type": "object",
+ "properties": {
+ "${{YOUR-PROPERTY-NAME}}": {
+ "type": "${{YOUR-PROPERTY-TYPE}}",
+ "description": "${{YOUR-PROPERTY-DESCRIPTION}}",
+ }
+ // You can add more query properties here
+ }
+ },
+ "path": {
+ // Same as query properties
+ },
+ "body": {
+ // Same as query properties
+ }
+ }
+ }
+ }
+ ```
+
+1. Update `./src/adaptiveCards`
+
+ Create a new file with name `${{YOUR-API-NAME}}.json`, and fill in the adaptive card for the API response of your API.
+
+1. Update `./src/app/app.ts`
+
+ Add following code before `export default app;`. Remember to replace necessary info.
+
+ ```
+ app.ai.action(${{YOUR-API-NAME}}, async (context: TurnContext, state: ApplicationTurnState, parameter: any) => {
+ const client = await api.getClient();
+
+ const path = client.paths[${{YOUR-API-PATH}}];
+ if (path && path.${{YOUR-API-METHOD}}) {
+ const result = await path.${{YOUR-API-METHOD}}(parameter.path, parameter.body, {
+ params: parameter.query,
+ });
+ const card = generateAdaptiveCard("../adaptiveCards/${{YOUR-API-NAME}}.json", result);
+ await context.sendActivity({ attachments: [card] });
+ } else {
+ await context.sendActivity("no result");
+ }
+ return "result";
+ });
+ ```
+
+1. Run `Local Debug` or `Provision` and `Deploy` to run this app again.
## Additional information and references
- [Teams AI library](https://aka.ms/teams-ai-library)
diff --git a/templates/ts/custom-copilot-rag-custom-api/infra/azure.parameters.json.tpl b/templates/ts/custom-copilot-rag-custom-api/infra/azure.parameters.json.tpl
index eaeeb233a6..81e8292e6f 100644
--- a/templates/ts/custom-copilot-rag-custom-api/infra/azure.parameters.json.tpl
+++ b/templates/ts/custom-copilot-rag-custom-api/infra/azure.parameters.json.tpl
@@ -24,7 +24,7 @@
"value": "${{AZURE_OPENAI_ENDPOINT}}"
},
"azureOpenAIDeployment": {
- "value": "${{AZURE_OPENAI_DEPLOYMENT}}
+ "value": "${{AZURE_OPENAI_DEPLOYMENT}}"
},
{{/useAzureOpenAI}}
"webAppSKU": {
diff --git a/templates/ts/custom-copilot-rag-custom-api/package.json.tpl b/templates/ts/custom-copilot-rag-custom-api/package.json.tpl
index 5b2048de69..3dc5806536 100644
--- a/templates/ts/custom-copilot-rag-custom-api/package.json.tpl
+++ b/templates/ts/custom-copilot-rag-custom-api/package.json.tpl
@@ -16,7 +16,7 @@
"dev:teamsfx:testtool": "env-cmd --silent -f .localConfigs.testTool npm run dev",
"dev:teamsfx:launch-testtool": "env-cmd --silent -f env/.env.testtool teamsapptester start",
"dev": "nodemon --exec node --inspect=9239 --signal SIGINT -r ts-node/register ./src/index.ts",
- "build": "tsc --build && shx cp -r ./src/prompts ./lib/src",
+ "build": "tsc --build && shx cp -r ./src/prompts ./lib/src && shx cp -r ./appPackage ./lib/appPackage && shx cp -r src/adaptiveCards ./lib/src",
"start": "node ./lib/src/index.js",
"test": "echo \"Error: no test specified\" && exit 1",
"watch": "nodemon --exec \"npm run start\""
diff --git a/templates/ts/custom-copilot-rag-custom-api/src/adapter.ts b/templates/ts/custom-copilot-rag-custom-api/src/adapter.ts
index 1cf10f4bb8..a0d306983b 100644
--- a/templates/ts/custom-copilot-rag-custom-api/src/adapter.ts
+++ b/templates/ts/custom-copilot-rag-custom-api/src/adapter.ts
@@ -40,8 +40,7 @@ const onTurnErrorHandler = async (context, error) => {
);
// Send a message to the user
- await context.sendActivity("The bot encountered an error or bug.");
- await context.sendActivity("To continue to run this bot, please fix the bot source code.");
+ await context.sendActivity(`The bot encountered an error or bug: ${error.message}`);
}
};
diff --git a/templates/ts/custom-copilot-rag-custom-api/src/app/app.ts.tpl b/templates/ts/custom-copilot-rag-custom-api/src/app/app.ts.tpl
index efb64db0ec..4893014ba0 100644
--- a/templates/ts/custom-copilot-rag-custom-api/src/app/app.ts.tpl
+++ b/templates/ts/custom-copilot-rag-custom-api/src/app/app.ts.tpl
@@ -37,7 +37,7 @@ const app = new Application({
},
});
-import { generateAdaptiveCard } from "./utility";
+import { generateAdaptiveCard, addAuthConfig } from "./utility";
import { TurnContext, ConversationState } from "botbuilder";
import { TurnState, Memory } from "@microsoft/teams-ai";
import yaml from "js-yaml";
diff --git a/templates/ts/custom-copilot-rag-custom-api/src/app/utility.ts b/templates/ts/custom-copilot-rag-custom-api/src/app/utility.ts
index f14c93e5d5..00ae6c1c61 100644
--- a/templates/ts/custom-copilot-rag-custom-api/src/app/utility.ts
+++ b/templates/ts/custom-copilot-rag-custom-api/src/app/utility.ts
@@ -1,5 +1,6 @@
import { CardFactory } from "botbuilder";
const ACData = require("adaptivecards-templating");
+import { OpenAPIClient } from "openapi-client-axios";
export function generateAdaptiveCard(templatePath: string, result: any) {
if (!result || !result.data) {
throw new Error("Get empty result from api call.");
@@ -12,3 +13,28 @@ export function generateAdaptiveCard(templatePath: string, result: any) {
const card = CardFactory.adaptiveCard(cardContent);
return card;
}
+
+export function addAuthConfig(client: OpenAPIClient) {
+ // This part is sample code for adding authentication to the client.
+ // Please replace it with your own authentication logic.
+ // Please refer to https://openapistack.co/docs/openapi-client-axios/intro/ for more info about the client.
+ /*
+ client.interceptors.request.use((config) => {
+ // You can specify different authentication methods for different urls and methods.
+ if (config.url == "your-url" && config.method == "your-method") {
+ // You can update the target url
+ config.url = "your-new-url";
+
+ // For Basic Authentication
+ config.headers["Authorization"] = `Basic ${btoa("Your-Username:Your-Password")}`;
+
+ // For Cookie
+ config.headers["Cookie"] = `Your-Cookie`;
+
+ // For Bearer Token
+ config.headers["Authorization"] = `Bearer "Your-Token"`;
+ }
+ return config;
+ });
+ */
+}
diff --git a/templates/ts/custom-copilot-rag-custom-api/teamsapp.local.yml.tpl b/templates/ts/custom-copilot-rag-custom-api/teamsapp.local.yml.tpl
index 4a07c05f81..267e41f9e0 100644
--- a/templates/ts/custom-copilot-rag-custom-api/teamsapp.local.yml.tpl
+++ b/templates/ts/custom-copilot-rag-custom-api/teamsapp.local.yml.tpl
@@ -15,15 +15,19 @@ provision:
teamsAppId: TEAMS_APP_ID
# Create or reuse an existing Microsoft Entra application for bot.
- - uses: botAadApp/create
+ - uses: aadApp/create
with:
# The Microsoft Entra application's display name
name: {{appName}}${{APP_NAME_SUFFIX}}
+ generateClientSecret: true
+ signInAudience: AzureADMultipleOrgs
writeToEnvironmentFile:
# The Microsoft Entra application's client id created for bot.
- botId: BOT_ID
+ clientId: BOT_ID
# The Microsoft Entra application's client secret created for bot.
- botPassword: SECRET_BOT_PASSWORD
+ clientSecret: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's object id created for bot.
+ objectId: BOT_OBJECT_ID
# Create or update the bot registration on dev.botframework.com
- uses: botFramework/create
diff --git a/templates/ts/custom-copilot-rag-custom-api/teamsapp.yml.tpl b/templates/ts/custom-copilot-rag-custom-api/teamsapp.yml.tpl
index ad88b620cc..b253e3db1b 100644
--- a/templates/ts/custom-copilot-rag-custom-api/teamsapp.yml.tpl
+++ b/templates/ts/custom-copilot-rag-custom-api/teamsapp.yml.tpl
@@ -18,15 +18,19 @@ provision:
teamsAppId: TEAMS_APP_ID
# Create or reuse an existing Microsoft Entra application for bot.
- - uses: botAadApp/create
+ - uses: aadApp/create
with:
# The Microsoft Entra application's display name
name: {{appName}}${{APP_NAME_SUFFIX}}
+ generateClientSecret: true
+ signInAudience: AzureADMultipleOrgs
writeToEnvironmentFile:
# The Microsoft Entra application's client id created for bot.
- botId: BOT_ID
+ clientId: BOT_ID
# The Microsoft Entra application's client secret created for bot.
- botPassword: SECRET_BOT_PASSWORD
+ clientSecret: SECRET_BOT_PASSWORD
+ # The Microsoft Entra application's object id created for bot.
+ objectId: BOT_OBJECT_ID
- uses: arm/deploy # Deploy given ARM templates parallelly.
with:
diff --git a/templates/ts/dashboard-tab/README.md b/templates/ts/dashboard-tab/README.md
index 3a0cf4794a..65b5b2c411 100644
--- a/templates/ts/dashboard-tab/README.md
+++ b/templates/ts/dashboard-tab/README.md
@@ -14,7 +14,7 @@ This template showcases an app that embeds a canvas containing multiple cards th
> - [Node.js](https://nodejs.org/), supported versions: 16, 18
> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts)
> - [Set up your dev environment for extending Teams apps across Microsoft 365](https://aka.ms/teamsfx-m365-apps-prerequisites)
-> Please note that after you enrolled your developer tenant in Office 365 Target Release, it may take couple days for the enrollment to take effect.
+> Please note that after you enrolled your developer tenant in Office 365 Target Release, it may take couple days for the enrollment to take effect.
> - [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)
1. First, select the Teams Toolkit icon on the left in the VS Code toolbar.
@@ -29,7 +29,7 @@ This template showcases an app that embeds a canvas containing multiple cards th
## What's included in the template
| Folder | Contents |
-| - | -|
+| ------------ | --------------------------------------------------- |
| `.vscode` | VSCode files for debugging |
| `appPackage` | Templates for the Teams application manifest |
| `env` | Environment files |
@@ -39,7 +39,7 @@ This template showcases an app that embeds a canvas containing multiple cards th
The following files can be customized and demonstrate an example implementation to get you started.
| File | Contents |
-| - | -|
+| ------------------------------------ | -------------------------------------------------- |
| `src/models/chartModel.ts` | Data model for the chart widget |
| `src/models/listModel.ts` | Data model for the list widget |
| `src/services/chartService.ts` | A data retrive implementation for the chart widget |
@@ -54,18 +54,18 @@ The following files can be customized and demonstrate an example implementation
The following are project-related files. You generally will not need to customize these files.
-| File | Contents |
-| - | - |
-| `src/index.css` | The style of application entry point |
-| `src/index.tsx` | Application entry point |
-| `src/internal/context.ts` | TeamsFx Context |
+| File | Contents |
+| ------------------------- | ------------------------------------ |
+| `src/index.css` | The style of application entry point |
+| `src/index.tsx` | Application entry point |
+| `src/internal/context.ts` | TeamsFx Context |
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.|
-|`teamsapp.local.yml`|This overrides `teamsapp.yml` with actions that enable local execution and debugging.|
+| File | Contents |
+| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
+| `teamsapp.yml` | This is the main Teams Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions. |
+| `teamsapp.local.yml` | This overrides `teamsapp.yml` with actions that enable local execution and debugging. |
## Extend the Dashboard template to add a new widget
@@ -108,8 +108,8 @@ export const getSampleData = (): SampleModel => {
Create a widget file in the `src/widgets` folder. Inherit the `BaseWidget` class from `@microsoft/teamsfx-react`. The following table lists the methods that you can override to customize your widget.
-| Methods | Function |
-| - | -|
+| Methods | Function |
+| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `getData()` | This method is used to get the data for the widget. You can implement it to get data from the backend service or from the Microsoft Graph API |
| `header()` | Customize the content of the widget header |
| `body()` | Customize the content of the widget body |
@@ -189,6 +189,7 @@ override layout(): JSX.Element | undefined {
);
}
```
+
Congratulations, you've just added your own widget! To learn more about the dashboard template, [visit the documentation](https://aka.ms/teamsfx-dashboard-new). You can find more scenarios like:
- [Customize the widget](https://aka.ms/teamsfx-dashboard-new#customize-the-widget)
diff --git a/templates/ts/default-bot-message-extension/README.md b/templates/ts/default-bot-message-extension/README.md
index 2f0621af79..3fe4da7e04 100644
--- a/templates/ts/default-bot-message-extension/README.md
+++ b/templates/ts/default-bot-message-extension/README.md
@@ -34,7 +34,8 @@ This is a simple hello world application with both Bot and Message extension cap
## Edit the manifest
You can find the Teams app manifest in `./appPackage` folder. The folder contains one manifest file:
-* `manifest.json`: Manifest file for Teams app running locally or running remotely (After deployed to Azure).
+
+- `manifest.json`: Manifest file for Teams app running locally or running remotely (After deployed to Azure).
This file contains template arguments with `${{...}}` statements which will be replaced at build time. You may add any extra properties or permissions you require to this file. See the [schema reference](https://docs.microsoft.com/en-us/microsoftteams/platform/resources/schema/manifest-schema) for more information.
@@ -42,8 +43,8 @@ This file contains template arguments with `${{...}}` statements which will be r
Deploy your project to Azure by following these steps:
-| From Visual Studio Code | From TeamsFx CLI |
-| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| From Visual Studio Code | From TeamsFx CLI |
+| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|