diff --git a/js/samples/01.getting-started/a.echoBot/README.md b/js/samples/01.getting-started/a.echoBot/README.md index 2a2f232cb..51bcb7aa0 100644 --- a/js/samples/01.getting-started/a.echoBot/README.md +++ b/js/samples/01.getting-started/a.echoBot/README.md @@ -6,12 +6,12 @@ This sample shows how to incorporate a basic conversational flow into a Microsof -- [Teams Echo Bot](#teams-echo-bot) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) - - [Using Teams App test tool](#using-teams-app-test-tool) +- [Teams Echo Bot](#teams-echo-bot) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) + - [Using Teams App test tool](#using-teams-app-test-tool) @@ -77,7 +77,7 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Copy this sample into a new folder outside of teams-ai 1. Select **File > Open Folder** in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps. -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams.. diff --git a/js/samples/02.teams-features/a.messageExtensions.searchCommand/README.md b/js/samples/02.teams-features/a.messageExtensions.searchCommand/README.md index aa8e61d5d..a338bbb9f 100644 --- a/js/samples/02.teams-features/a.messageExtensions.searchCommand/README.md +++ b/js/samples/02.teams-features/a.messageExtensions.searchCommand/README.md @@ -7,17 +7,17 @@ This sample shows how to incorporate a basic Message Extension app into a Micros - [Teams Search Command Message Extension](#teams-search-command-message-extension) - - [Interacting with the message extension](#interacting-with-the-message-extension) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) + - [Interacting with the message extension](#interacting-with-the-message-extension) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) ## Interacting with the message extension -- Message Extensions are convenient ways to add functionality to Teams. -- This sample adds a search command to the compose area of a chat. +- Message Extensions are convenient ways to add functionality to Teams. +- This sample adds a search command to the compose area of a chat. > Note: this is not a chat bot and therefore the bot does not respond if you talk to it. Once it is installed in Teams, you can interact with it by selecting it's app icon in the chat compose area. @@ -79,7 +79,7 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/js/samples/02.teams-features/b.adaptiveCards.typeAheadBot/README.md b/js/samples/02.teams-features/b.adaptiveCards.typeAheadBot/README.md index 0721a2295..eba92a671 100644 --- a/js/samples/02.teams-features/b.adaptiveCards.typeAheadBot/README.md +++ b/js/samples/02.teams-features/b.adaptiveCards.typeAheadBot/README.md @@ -6,20 +6,20 @@ This sample shows how to incorporate Adaptive Cards into a Microsoft Teams appli -- [Type-Ahead Search](#type-ahead-search) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) - - [Using Teams App test tool](#using-teams-app-test-tool) +- [Type-Ahead Search](#type-ahead-search) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) + - [Using Teams App test tool](#using-teams-app-test-tool) ## Interacting with the bot -- You can interact by sending 'dynamic' or 'static' to the app. The app will respond with an Adaptive Card. -- Typing into the search box will filter the list of options. Selecting an option and submitting will send a message to the bot with the selected option(s). -- The Adaptive Cards used are `json` files located under `/src/cards`. You can use the Teams developer portal to design and host your Adaptive Cards. +- You can interact by sending 'dynamic' or 'static' to the app. The app will respond with an Adaptive Card. +- Typing into the search box will filter the list of options. Selecting an option and submitting will send a message to the bot with the selected option(s). +- The Adaptive Cards used are `json` files located under `/src/cards`. You can use the Teams developer portal to design and host your Adaptive Cards. ## Setting up the sample @@ -77,7 +77,7 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. @@ -93,4 +93,4 @@ Use **Teams App test tool** (integrated into teams Toolkit) to run this sample. 1. Select File > Open Folder in VS Code and choose this sample's directory 1. From the left pane, select **Run and Debug**(Ctrl+Shift+D) and select **Debug in Test Tool** in dropdown list. 1. Select Debug > Start Debugging or F5 to run the app. -1. The browser will pop up to open Teams App Test Tool. \ No newline at end of file +1. The browser will pop up to open Teams App Test Tool. diff --git a/js/samples/03.ai-concepts/a.twentyQuestions/README.md b/js/samples/03.ai-concepts/a.twentyQuestions/README.md index dba47c10f..4475bbfe8 100644 --- a/js/samples/03.ai-concepts/a.twentyQuestions/README.md +++ b/js/samples/03.ai-concepts/a.twentyQuestions/README.md @@ -7,10 +7,10 @@ Welcome to the 20 Questions Bot: The Ultimate Guessing Game! This developer samp - [AI in Microsoft Teams: Twenty Questions](#ai-in-microsoft-teams-twenty-questions) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) - - [Using Teams App test tool](#using-teams-app-test-tool) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) + - [Using Teams App test tool](#using-teams-app-test-tool) @@ -58,7 +58,6 @@ Welcome to the 20 Questions Bot: The Ultimate Guessing Game! This developer samp 1. If developing without Teams Toolkit, add your OpenAI or Azure OpenAI key to the `OPENAI_KEY` or `AZURE_OPENAI_KEY` and `AZURE_OPENAI_ENDPOINT` variable(s) in `.env` file, which you can copy from `sample.env`. If using TTK, continue following the directions below. - ## Testing the sample The easiest and fastest way to get up and running is with Teams Toolkit as your development guide. @@ -106,7 +105,7 @@ If you are using Azure OpenAI then follow these steps: 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. @@ -123,13 +122,14 @@ If you are using Azure OpenAI then follow these steps: ```yml - uses: file/createOrUpdateEnvironmentFile with: - target: ./.localConfigs.testTool - envs: - TEAMSFX_NOTIFICATION_STORE_FILENAME: ${{TEAMSFX_NOTIFICATION_STORE_FILENAME}} - # OPENAI_KEY: ${{SECRET_OPENAI_KEY}} - AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}} - AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} + target: ./.localConfigs.testTool + envs: + TEAMSFX_NOTIFICATION_STORE_FILENAME: ${{TEAMSFX_NOTIFICATION_STORE_FILENAME}} + # OPENAI_KEY: ${{SECRET_OPENAI_KEY}} + AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}} + AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` + 1. Ensure you have downloaded and installed [Visual Studio Code](https://code.visualstudio.com/docs/setup/setup-overview) 1. Install the [Teams Toolkit extension](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension) 1. Copy this sample into a new folder outside of teams-ai diff --git a/js/samples/03.ai-concepts/b.AI-messageExtensions/README.md b/js/samples/03.ai-concepts/b.AI-messageExtensions/README.md index e23a8aece..f3779bc5d 100644 --- a/js/samples/03.ai-concepts/b.AI-messageExtensions/README.md +++ b/js/samples/03.ai-concepts/b.AI-messageExtensions/README.md @@ -6,11 +6,11 @@ This sample is a message extension (ME) for Microsoft Teams that leverages the g -- [AI in Microsoft Teams Message Extensions: GPT-ME](#ai-in-microsoft-teams-message-extensions-gpt-me) - - [Summary](#summary) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) +- [AI in Microsoft Teams Message Extensions: GPT-ME](#ai-in-microsoft-teams-message-extensions-gpt-me) + - [Summary](#summary) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) @@ -76,9 +76,9 @@ To use Teams Toolkit, continue following the directions below. If you are using Azure OpenAI then follow these steps: -- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. -- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables -- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: +- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. +- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables +- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: ```yml - uses: file/createOrUpdateEnvironmentFile @@ -92,8 +92,8 @@ If you are using Azure OpenAI then follow these steps: AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` -- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. -- Open `./infra/azure.parameters.json` and replace lines 20-22 with: +- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. +- Open `./infra/azure.parameters.json` and replace lines 20-22 with: ```json "azureOpenAIKey": { @@ -109,7 +109,7 @@ If you are using Azure OpenAI then follow these steps: 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/js/samples/03.ai-concepts/c.actionMapping-lightBot/README.md b/js/samples/03.ai-concepts/c.actionMapping-lightBot/README.md index 924045bad..19963502e 100644 --- a/js/samples/03.ai-concepts/c.actionMapping-lightBot/README.md +++ b/js/samples/03.ai-concepts/c.actionMapping-lightBot/README.md @@ -6,12 +6,12 @@ LightBot: Your Enlightened Assistant. This example showcases how the LightBot un -- [AI in Microsoft Teams: Light Bot](#ai-in-microsoft-teams-light-bot) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) - - [Using Teams App Test Tool](#using-teams-app-test-tool) +- [AI in Microsoft Teams: Light Bot](#ai-in-microsoft-teams-light-bot) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) + - [Using Teams App Test Tool](#using-teams-app-test-tool) @@ -81,9 +81,9 @@ To use Teams Toolkit, continue following the directions below. If you are using Azure OpenAI then follow these steps: -- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. -- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables -- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: +- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. +- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables +- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: ```yml - uses: file/createOrUpdateEnvironmentFile @@ -97,8 +97,8 @@ If you are using Azure OpenAI then follow these steps: AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` -- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. -- Open `./infra/azure.parameters.json` and replace lines 20-22 with: +- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. +- Open `./infra/azure.parameters.json` and replace lines 20-22 with: ```json "azureOpenAIKey": { @@ -114,7 +114,7 @@ If you are using Azure OpenAI then follow these steps: 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. @@ -131,17 +131,18 @@ If you are using Azure OpenAI then follow these steps: ```yml - uses: file/createOrUpdateEnvironmentFile with: - target: ./.localConfigs.testTool - envs: - TEAMSFX_NOTIFICATION_STORE_FILENAME: ${{TEAMSFX_NOTIFICATION_STORE_FILENAME}} - # OPENAI_KEY: ${{SECRET_OPENAI_KEY}} - AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}} - AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} + target: ./.localConfigs.testTool + envs: + TEAMSFX_NOTIFICATION_STORE_FILENAME: ${{TEAMSFX_NOTIFICATION_STORE_FILENAME}} + # OPENAI_KEY: ${{SECRET_OPENAI_KEY}} + AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}} + AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` + 1. Ensure you have downloaded and installed [Visual Studio Code](https://code.visualstudio.com/docs/setup/setup-overview) 1. Install the [Teams Toolkit extension](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension) 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. From the left pane, select **Run and Debug**(Ctrl+Shift+D) and select **Debug in Test Tool** in dropdown list. 1. Select Debug > Start Debugging or F5 to run the app. -1. The browser will pop up to open Teams App Test Tool. \ No newline at end of file +1. The browser will pop up to open Teams App Test Tool. diff --git a/js/samples/03.ai-concepts/d.chainedActions-listBot/README.md b/js/samples/03.ai-concepts/d.chainedActions-listBot/README.md index 4d9d6fb36..d4ce876b5 100644 --- a/js/samples/03.ai-concepts/d.chainedActions-listBot/README.md +++ b/js/samples/03.ai-concepts/d.chainedActions-listBot/README.md @@ -6,12 +6,12 @@ ListBot: Your Ultimate List Management Companion. Powered by advanced AI capabil -- [AI in Microsoft Teams: List Bot](#ai-in-microsoft-teams-list-bot) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) - - [Using Teams App Test Tool](#using-teams-app-test-tool) +- [AI in Microsoft Teams: List Bot](#ai-in-microsoft-teams-list-bot) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) + - [Using Teams App Test Tool](#using-teams-app-test-tool) @@ -159,9 +159,9 @@ To use Teams Toolkit, continue following the directions below. If you are using Azure OpenAI then follow these steps: -- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. -- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables -- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: +- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. +- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables +- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: ```yml - uses: file/createOrUpdateEnvironmentFile @@ -175,8 +175,8 @@ If you are using Azure OpenAI then follow these steps: AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` -- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. -- Open `./infra/azure.parameters.json` and replace lines 20-22 with: +- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. +- Open `./infra/azure.parameters.json` and replace lines 20-22 with: ```json "azureOpenAIKey": { @@ -192,7 +192,7 @@ If you are using Azure OpenAI then follow these steps: 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. @@ -209,17 +209,18 @@ If you are using Azure OpenAI then follow these steps: ```yml - uses: file/createOrUpdateEnvironmentFile with: - target: ./.localConfigs.testTool - envs: - TEAMSFX_NOTIFICATION_STORE_FILENAME: ${{TEAMSFX_NOTIFICATION_STORE_FILENAME}} - # OPENAI_KEY: ${{SECRET_OPENAI_KEY}} - AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}} - AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} + target: ./.localConfigs.testTool + envs: + TEAMSFX_NOTIFICATION_STORE_FILENAME: ${{TEAMSFX_NOTIFICATION_STORE_FILENAME}} + # OPENAI_KEY: ${{SECRET_OPENAI_KEY}} + AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}} + AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` + 1. Ensure you have downloaded and installed [Visual Studio Code](https://code.visualstudio.com/docs/setup/setup-overview) 1. Install the [Teams Toolkit extension](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension) 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. From the left pane, select **Run and Debug**(Ctrl+Shift+D) and select **Debug in Test Tool** in dropdown list. 1. Select Debug > Start Debugging or F5 to run the app. -1. The browser will pop up to open Teams App Test Tool. \ No newline at end of file +1. The browser will pop up to open Teams App Test Tool. diff --git a/js/samples/03.ai-concepts/e.customModel-LLAMA/README.md b/js/samples/03.ai-concepts/e.customModel-LLAMA/README.md index 60231688c..b4fa90e25 100644 --- a/js/samples/03.ai-concepts/e.customModel-LLAMA/README.md +++ b/js/samples/03.ai-concepts/e.customModel-LLAMA/README.md @@ -6,12 +6,12 @@ This sample implements a custom model to utilize Meta Llama's capabilities in Mi -- [Meta Llama2 in Microsoft Teams](#meta-llama2-in-microsoft-teams) - - [Summary](#summary) - - [Obtaining a deployed Llama 2 model in Azure](#obtaining-a-deployed-llama-2-model-in-azure) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) +- [Meta Llama2 in Microsoft Teams](#meta-llama2-in-microsoft-teams) + - [Summary](#summary) + - [Obtaining a deployed Llama 2 model in Azure](#obtaining-a-deployed-llama-2-model-in-azure) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) @@ -106,7 +106,7 @@ To use Teams Toolkit, continue following the directions below. 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/js/samples/03.ai-concepts/f.chatModeration/README.md b/js/samples/03.ai-concepts/f.chatModeration/README.md index e5360145e..a16bd6e15 100644 --- a/js/samples/03.ai-concepts/f.chatModeration/README.md +++ b/js/samples/03.ai-concepts/f.chatModeration/README.md @@ -6,11 +6,11 @@ This sample shows how to incorporate Content Safety control into a Microsoft Tea -- [Chat Bot with Moderation Control](#chat-bot-with-moderation-control) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) +- [Chat Bot with Moderation Control](#chat-bot-with-moderation-control) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) @@ -76,9 +76,9 @@ To use Teams Toolkit, continue following the directions below. If you are using Azure OpenAI then follow these steps: -- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. -- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables -- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: +- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. +- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables +- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: ```yml - uses: file/createOrUpdateEnvironmentFile @@ -92,8 +92,8 @@ If you are using Azure OpenAI then follow these steps: AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` -- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. -- Open `./infra/azure.parameters.json` and replace lines 20-22 with: +- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. +- Open `./infra/azure.parameters.json` and replace lines 20-22 with: ```json "azureOpenAIKey": { @@ -109,7 +109,7 @@ If you are using Azure OpenAI then follow these steps: 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/js/samples/04.ai-apps/a.teamsChefBot/README.md b/js/samples/04.ai-apps/a.teamsChefBot/README.md index 122d5101a..1788d48d8 100644 --- a/js/samples/04.ai-apps/a.teamsChefBot/README.md +++ b/js/samples/04.ai-apps/a.teamsChefBot/README.md @@ -6,12 +6,12 @@ This is a conversational bot for Microsoft Teams that thinks it's a Chef to help -- [Microsoft Teams Conversational Bot with AI: Teams Chef](#microsoft-teams-conversational-bot-with-ai-teams-chef) - - [Summary](#summary) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) - - [Using Teams App test tool](#using-teams-app-test-tool) +- [Microsoft Teams Conversational Bot with AI: Teams Chef](#microsoft-teams-conversational-bot-with-ai-teams-chef) + - [Summary](#summary) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) + - [Using Teams App test tool](#using-teams-app-test-tool) @@ -44,9 +44,9 @@ code . If you are using Azure OpenAI then follow these steps: -- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. -- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables. -- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: +- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. +- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables. +- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: ```yml - uses: file/createOrUpdateEnvironmentFile @@ -60,8 +60,8 @@ If you are using Azure OpenAI then follow these steps: AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` -- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. -- Open `./infra/azure.parameters.json` and replace lines 20-22 with: +- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. +- Open `./infra/azure.parameters.json` and replace lines 20-22 with: ```json "azureOpenAIKey": { @@ -92,7 +92,7 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. @@ -109,17 +109,18 @@ If you are using Azure OpenAI then follow these steps: ```yml - uses: file/createOrUpdateEnvironmentFile with: - target: ./.localConfigs.testTool - envs: - TEAMSFX_NOTIFICATION_STORE_FILENAME: ${{TEAMSFX_NOTIFICATION_STORE_FILENAME}} - # OPENAI_KEY: ${{SECRET_OPENAI_KEY}} - AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}} - AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} + target: ./.localConfigs.testTool + envs: + TEAMSFX_NOTIFICATION_STORE_FILENAME: ${{TEAMSFX_NOTIFICATION_STORE_FILENAME}} + # OPENAI_KEY: ${{SECRET_OPENAI_KEY}} + AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}} + AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` + 1. Ensure you have downloaded and installed [Visual Studio Code](https://code.visualstudio.com/docs/setup/setup-overview) 1. Install the [Teams Toolkit extension](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension) 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. From the left pane, select **Run and Debug**(Ctrl+Shift+D) and select **Debug in Test Tool** in dropdown list. 1. Select Debug > Start Debugging or F5 to run the app. -1. The browser will pop up to open Teams App Test Tool. \ No newline at end of file +1. The browser will pop up to open Teams App Test Tool. diff --git a/js/samples/04.ai-apps/b.devOpsBot/README.md b/js/samples/04.ai-apps/b.devOpsBot/README.md index 85441c591..eb016023f 100644 --- a/js/samples/04.ai-apps/b.devOpsBot/README.md +++ b/js/samples/04.ai-apps/b.devOpsBot/README.md @@ -6,11 +6,11 @@ This is a conversational bot for Microsoft Teams that demonstrates how you could -- [Microsoft Teams Conversational Bot: DevOps Bot](#microsoft-teams-conversational-bot-devops-bot) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) +- [Microsoft Teams Conversational Bot: DevOps Bot](#microsoft-teams-conversational-bot-devops-bot) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) @@ -22,23 +22,23 @@ You can interact with this bot by sending it a message. The bot will respond to 1. **create work item to track new functionality in Adaptive card and assign it to John** -- **Result:** The bot will create a tracking item in Azure DevOps and assign it to John -- **Valid Scopes:** personal, group chat, team chat +- **Result:** The bot will create a tracking item in Azure DevOps and assign it to John +- **Valid Scopes:** personal, group chat, team chat 2. **update title of work item 1 to create a new bot in azure** -- **Result:** The bot will update the title of work item 1 to create a new bot in azure. -- **Valid Scopes:** personal, group chat, team chat +- **Result:** The bot will update the title of work item 1 to create a new bot in azure. +- **Valid Scopes:** personal, group chat, team chat 3. **triage work item 1 as "in progress"** -- **Result:** The bot will update the state of work item 1 to "in progress". -- **Valid Scopes:** personal, group chat, team chat +- **Result:** The bot will update the state of work item 1 to "in progress". +- **Valid Scopes:** personal, group chat, team chat 4. **summarize work items"** -- **Result:** The bot will summarize the work items and respond back with an adaptive card. -- **Valid Scopes:** personal, group chat, team chat +- **Result:** The bot will summarize the work items and respond back with an adaptive card. +- **Valid Scopes:** personal, group chat, team chat You can select an option from the command list by typing `@TeamsConversationBot` into the compose message area and `What can I do?` text above the compose area. @@ -100,9 +100,9 @@ To use Teams Toolkit, continue following the directions below. If you are using Azure OpenAI then follow these steps: -- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. -- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables -- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: +- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. +- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables +- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: ```yml - uses: file/createOrUpdateEnvironmentFile @@ -116,8 +116,8 @@ If you are using Azure OpenAI then follow these steps: AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` -- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. -- Open `./infra/azure.parameters.json` and replace lines 20-22 with: +- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. +- Open `./infra/azure.parameters.json` and replace lines 20-22 with: ```json "azureOpenAIKey": { @@ -133,7 +133,7 @@ If you are using Azure OpenAI then follow these steps: 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/js/samples/04.ai-apps/c.vision-cardGazer/README.md b/js/samples/04.ai-apps/c.vision-cardGazer/README.md index 54f270083..d24b20414 100644 --- a/js/samples/04.ai-apps/c.vision-cardGazer/README.md +++ b/js/samples/04.ai-apps/c.vision-cardGazer/README.md @@ -8,11 +8,11 @@ _Table of contents_ -- [Microsoft Teams Vision Enabled Bot : Card Gazer](#microsoft-teams-vision-enabled-bot--card-gazer) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) +- [Microsoft Teams Vision Enabled Bot : Card Gazer](#microsoft-teams-vision-enabled-bot--card-gazer) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) @@ -78,9 +78,9 @@ To use Teams Toolkit, continue following the directions below. If you are using Azure OpenAI then follow these steps: -- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. -- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables -- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: +- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. +- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables +- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: ```yml - uses: file/createOrUpdateEnvironmentFile @@ -94,8 +94,8 @@ If you are using Azure OpenAI then follow these steps: AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` -- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. -- Open `./infra/azure.parameters.json` and replace lines 20-22 with: +- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. +- Open `./infra/azure.parameters.json` and replace lines 20-22 with: ```json "azureOpenAIKey": { @@ -111,7 +111,7 @@ If you are using Azure OpenAI then follow these steps: 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/js/samples/04.ai-apps/d.assistants-mathBot/README.md b/js/samples/04.ai-apps/d.assistants-mathBot/README.md index ea7a7078f..c2a23e229 100644 --- a/js/samples/04.ai-apps/d.assistants-mathBot/README.md +++ b/js/samples/04.ai-apps/d.assistants-mathBot/README.md @@ -7,10 +7,10 @@ This example shows how to create a basic conversational experience using OpenAI' - [Math Tutor Assistant](#math-tutor-assistant) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) @@ -74,9 +74,9 @@ To use Teams Toolkit, continue following the directions below. If you are using OpenAI then follow these steps: -- Comment out the the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables in the `./env/.env.local.user` file. -- Add your OpenAI key to the `SECRET_OPENAI_KEY` variable -- Open the `teamsapp.local.yml` file and modify the last step to use OpenAI variables instead. Be sure to comment out the Azure credentials: +- Comment out the the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables in the `./env/.env.local.user` file. +- Add your OpenAI key to the `SECRET_OPENAI_KEY` variable +- Open the `teamsapp.local.yml` file and modify the last step to use OpenAI variables instead. Be sure to comment out the Azure credentials: ```yml - uses: file/createOrUpdateEnvironmentFile @@ -90,8 +90,8 @@ If you are using OpenAI then follow these steps: # AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` -- Open `./infra/azure.bicep` and comment out lines 69-76 and uncomment lines 77-80. -- Open `./infra/azure.parameters.json` and replace lines 20-25 with: +- Open `./infra/azure.bicep` and comment out lines 69-76 and uncomment lines 77-80. +- Open `./infra/azure.parameters.json` and replace lines 20-25 with: ```json "openAIKey": { @@ -104,7 +104,7 @@ If you are using OpenAI then follow these steps: 3. Copy this sample into a new folder outside of teams-ai 4. Select File > Open Folder in VS Code and choose this sample's directory 5. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -6. Ensure that you have set up the sample from the previous step. +6. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 7. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 8. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/js/samples/04.ai-apps/e.assistants-orderBot/README.md b/js/samples/04.ai-apps/e.assistants-orderBot/README.md index 0ccc258d8..301c0118c 100644 --- a/js/samples/04.ai-apps/e.assistants-orderBot/README.md +++ b/js/samples/04.ai-apps/e.assistants-orderBot/README.md @@ -7,10 +7,10 @@ This example shows how to create a conversational assistant that uses tools to c - [Food Ordering Assistant](#food-ordering-assistant) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) @@ -74,9 +74,9 @@ To use Teams Toolkit, continue following the directions below. If you are using OpenAI then follow these steps: -- Comment the the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables in the `./env/.env.local.user` file. -- Add your OpenAI key to the `SECRET_OPENAI_KEY` variable -- Open the `teamsapp.local.yml` file and modify the last step to use OpenAI variables instead. Be sure to comment out the Azure credentials: +- Comment the the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables in the `./env/.env.local.user` file. +- Add your OpenAI key to the `SECRET_OPENAI_KEY` variable +- Open the `teamsapp.local.yml` file and modify the last step to use OpenAI variables instead. Be sure to comment out the Azure credentials: ```yml - uses: file/createOrUpdateEnvironmentFile @@ -90,8 +90,8 @@ If you are using OpenAI then follow these steps: # AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` -- Open `./infra/azure.bicep` and comment out lines 69-76 and uncomment lines 77-80. -- Open `./infra/azure.parameters.json` and replace lines 20-25 with: +- Open `./infra/azure.bicep` and comment out lines 69-76 and uncomment lines 77-80. +- Open `./infra/azure.parameters.json` and replace lines 20-25 with: ```json "openAIKey": { @@ -104,7 +104,7 @@ If you are using OpenAI then follow these steps: 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/js/samples/04.ai-apps/f.whoBot/README.md b/js/samples/04.ai-apps/f.whoBot/README.md index dc41e64fe..ad0b87828 100644 --- a/js/samples/04.ai-apps/f.whoBot/README.md +++ b/js/samples/04.ai-apps/f.whoBot/README.md @@ -4,11 +4,11 @@ This bot can tell you about your personal work-related information, who your man Note that this bot will only work in tenants where the following graph scopes are permitted: -- `User.Read` -- `User.ReadBasic.All` -- `People.Read` -- `Mail.Read` -- `Calendar.Read.Shared` +- `User.Read` +- `User.ReadBasic.All` +- `People.Read` +- `Mail.Read` +- `Calendar.Read.Shared` _Table of contents_ @@ -16,11 +16,11 @@ _Table of contents_ -- [Who Bot](#who-bot) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) +- [Who Bot](#who-bot) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) @@ -86,9 +86,9 @@ To use Teams Toolkit, continue following the directions below. If you are using Azure OpenAI then follow these steps: -- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. -- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables -- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: +- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. +- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables +- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: ```yml - uses: file/createOrUpdateEnvironmentFile @@ -102,8 +102,8 @@ If you are using Azure OpenAI then follow these steps: AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` -- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. -- Open `./infra/azure.parameters.json` and replace lines 20-22 with: +- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. +- Open `./infra/azure.parameters.json` and replace lines 20-22 with: ```json "azureOpenAIKey": { @@ -119,7 +119,7 @@ If you are using Azure OpenAI then follow these steps: 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/js/samples/04.ai-apps/g.datasource-azureAISearch/README.md b/js/samples/04.ai-apps/g.datasource-azureAISearch/README.md index a1e76858f..444217af3 100644 --- a/js/samples/04.ai-apps/g.datasource-azureAISearch/README.md +++ b/js/samples/04.ai-apps/g.datasource-azureAISearch/README.md @@ -6,13 +6,13 @@ The following is a conversational bot that is hooked on to GPT models but with c -- [Chat with Azure AI Search Data](#chat-with-azure-ai-search-data) - - [Summary](#summary) - - [Example Interaction](#example-interaction) - - [Observing the added context in the terminal](#observing-the-added-context-in-the-terminal) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) +- [Chat with Azure AI Search Data](#chat-with-azure-ai-search-data) + - [Summary](#summary) + - [Example Interaction](#example-interaction) + - [Observing the added context in the terminal](#observing-the-added-context-in-the-terminal) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) @@ -96,7 +96,7 @@ To use Teams Toolkit, continue following the directions below. 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/js/samples/04.ai-apps/i.teamsChefBot-streaming/README.md b/js/samples/04.ai-apps/i.teamsChefBot-streaming/README.md index 1d03f6096..7d5d777f9 100644 --- a/js/samples/04.ai-apps/i.teamsChefBot-streaming/README.md +++ b/js/samples/04.ai-apps/i.teamsChefBot-streaming/README.md @@ -6,12 +6,12 @@ This is a conversational streaming bot for Microsoft Teams that thinks it's a Ch -- [Microsoft Teams Conversational Bot with AI: Teams Chef](#microsoft-teams-conversational-bot-with-ai-teams-chef) - - [Summary](#summary) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) - - [Using Teams App test tool](#using-teams-app-test-tool) +- [Microsoft Teams Conversational Bot with AI: Teams Chef](#microsoft-teams-conversational-bot-with-ai-teams-chef) + - [Summary](#summary) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) + - [Using Teams App test tool](#using-teams-app-test-tool) @@ -22,20 +22,22 @@ This sample illustrates how to use [Retrieval Augmented Generation (RAG)](https: The sample uses a local Vector Database, called [Vectra](https://github.com/Stevenic/vectra), and [Semantic Search](https://en.wikipedia.org/wiki/Semantic_search) to find the most relevant information to include in the prompt for the users input. The index can be found in `./index/teams-ai` and includes all of the projects Getting Started docs and the source code for the Teams AI Library. This means you can ask the Teams Chef Bot anything about the library and it can answer it. You can even ask it to write sample code for you! ## Streaming -In addition, the sample illustrates our streaming feature. + +In addition, the sample illustrates our streaming feature. The following configurations are needed: + - Use the `DefaultAugmentation` class - Set `stream: true` in the `OpenAIModel` declaration Optional additions: -- Set the informative message in the `ActionPlanner` declaration via the `startStreamingMessage` config. -- Set attachments in the final chunk via the `endStreamHandler` in the `ActionPlanner` declaration. - - Useful methods include - - `streamer.setAttachments([...attachments])` - - `streamer.getMessage()` +- Set the informative message in the `ActionPlanner` declaration via the `startStreamingMessage` config. +- Set attachments in the final chunk via the `endStreamHandler` in the `ActionPlanner` declaration. + - Useful methods include + - `streamer.setAttachments([...attachments])` + - `streamer.getMessage()` ```js const model = new OpenAIModel({ @@ -80,9 +82,9 @@ code . If you are using Azure OpenAI then follow these steps: -- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. -- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables. -- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: +- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file. +- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables. +- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead: ```yml - uses: file/createOrUpdateEnvironmentFile @@ -96,8 +98,8 @@ If you are using Azure OpenAI then follow these steps: AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` -- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. -- Open `./infra/azure.parameters.json` and replace lines 20-22 with: +- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83. +- Open `./infra/azure.parameters.json` and replace lines 20-22 with: ```json "azureOpenAIKey": { @@ -128,7 +130,7 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. @@ -145,17 +147,18 @@ If you are using Azure OpenAI then follow these steps: ```yml - uses: file/createOrUpdateEnvironmentFile with: - target: ./.localConfigs.testTool - envs: - TEAMSFX_NOTIFICATION_STORE_FILENAME: ${{TEAMSFX_NOTIFICATION_STORE_FILENAME}} - # OPENAI_KEY: ${{SECRET_OPENAI_KEY}} - AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}} - AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} + target: ./.localConfigs.testTool + envs: + TEAMSFX_NOTIFICATION_STORE_FILENAME: ${{TEAMSFX_NOTIFICATION_STORE_FILENAME}} + # OPENAI_KEY: ${{SECRET_OPENAI_KEY}} + AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}} + AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}} ``` + 1. Ensure you have downloaded and installed [Visual Studio Code](https://code.visualstudio.com/docs/setup/setup-overview) 1. Install the [Teams Toolkit extension](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension) 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. From the left pane, select **Run and Debug**(Ctrl+Shift+D) and select **Debug in Test Tool** in dropdown list. 1. Select Debug > Start Debugging or F5 to run the app. -1. The browser will pop up to open Teams App Test Tool. \ No newline at end of file +1. The browser will pop up to open Teams App Test Tool. diff --git a/js/samples/05.authentication/a.oauth-adaptiveCard/README.md b/js/samples/05.authentication/a.oauth-adaptiveCard/README.md index 80a31f222..05088adaf 100644 --- a/js/samples/05.authentication/a.oauth-adaptiveCard/README.md +++ b/js/samples/05.authentication/a.oauth-adaptiveCard/README.md @@ -6,17 +6,17 @@ This sample requires creating an OAuth Connection in Azure Bot Service, which pr Note that this bot will only work in tenants where the following graph scopes are permitted: -- `User.Read` +- `User.Read` -- [Teams Adaptive Card SSO Bot](#teams-adaptive-card-sso-bot) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) +- [Teams Adaptive Card SSO Bot](#teams-adaptive-card-sso-bot) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) @@ -74,7 +74,7 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/js/samples/05.authentication/b.oauth-bot/README.md b/js/samples/05.authentication/b.oauth-bot/README.md index 7feb2852d..f4b51e574 100644 --- a/js/samples/05.authentication/b.oauth-bot/README.md +++ b/js/samples/05.authentication/b.oauth-bot/README.md @@ -6,17 +6,17 @@ This sample requires creating an OAuth Connection in Azure Bot Service, which pr Note that this bot will only work in tenants where the following graph scopes are permitted: -- `User.Read` +- `User.Read` -- [OAuth Bot](#oauth-bot) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) +- [OAuth Bot](#oauth-bot) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) @@ -78,7 +78,7 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/js/samples/05.authentication/c.oauth-messageExtension/README.md b/js/samples/05.authentication/c.oauth-messageExtension/README.md index 74a4901b1..43224e50d 100644 --- a/js/samples/05.authentication/c.oauth-messageExtension/README.md +++ b/js/samples/05.authentication/c.oauth-messageExtension/README.md @@ -6,17 +6,17 @@ This sample requires creating an OAuth Connection in Azure Bot Service, which pr Note that this bot will only work in tenants where the following graph scopes are permitted: -- `User.Read` +- `User.Read` -- [Teams Message Extension SSO Bot](#teams-message-extension-sso-bot) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) +- [Teams Message Extension SSO Bot](#teams-message-extension-sso-bot) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) @@ -32,7 +32,6 @@ Note that this bot will only work in tenants where the following graph scopes ar git clone https://github.com/Microsoft/teams-ai.git ``` - > [!IMPORTANT] > To prevent issues when installing dependencies after cloning the repo, copy or move the sample directory to it's own location first. @@ -84,7 +83,7 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/js/samples/05.authentication/d.teamsSSO-bot/README.md b/js/samples/05.authentication/d.teamsSSO-bot/README.md index d7d2abac4..37a6687ac 100644 --- a/js/samples/05.authentication/d.teamsSSO-bot/README.md +++ b/js/samples/05.authentication/d.teamsSSO-bot/README.md @@ -6,10 +6,10 @@ This sample depends on Teams SSO and gives you more flexibility on how to config ## Showcase -- The bot echos back any message it receives. That's it! -- This app is the bot-equivalent of 'Hello world'. -- The minimum setup shows how to set up a bot with the Teams AI SDK. -- This sample leverages Teams SSO to acquire a token for app user. +- The bot echos back any message it receives. That's it! +- This app is the bot-equivalent of 'Hello world'. +- The minimum setup shows how to set up a bot with the Teams AI SDK. +- This sample leverages Teams SSO to acquire a token for app user. ## Setting up the sample @@ -70,7 +70,7 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Copy this sample into a new folder outside of teams-ai 1. Select File > Open Folder in VS Code and choose this sample's directory 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. @@ -86,13 +86,13 @@ This sample is configured to work only in the tenant in which the Azure app regi ``` 1. Navigate to the `teamsapp.local.yml` file and set ```yml - signInAudience: "AzureADMultipleOrgs" # Authenticate users with a Microsoft work or school account in your organization's Azure AD tenant (for example, single tenant). + signInAudience: 'AzureADMultipleOrgs' # Authenticate users with a Microsoft work or school account in your organization's Azure AD tenant (for example, single tenant). ``` 1. Navigate to the `src/auth-start.html` page and set ```js let authorizeEndpoint = `https://login.microsoftonline.com/common/oauth2/v2.0/authorize?${toQueryString(queryParams)}`; ``` -2. Navigate to the `src/index.ts` file and on line 81 set +1. Navigate to the `src/index.ts` file and on line 81 set ```js - authority: `${process.env.AAD_APP_OAUTH_AUTHORITY_HOST}/common` - ``` \ No newline at end of file + authority: `${process.env.AAD_APP_OAUTH_AUTHORITY_HOST}/common`; + ``` diff --git a/js/samples/05.authentication/e.teamsSSO-messageExtension/README.md b/js/samples/05.authentication/e.teamsSSO-messageExtension/README.md index dc8448911..fabd54558 100644 --- a/js/samples/05.authentication/e.teamsSSO-messageExtension/README.md +++ b/js/samples/05.authentication/e.teamsSSO-messageExtension/README.md @@ -6,9 +6,9 @@ This sample depends on Teams SSO and gives you more flexibility on how to config ## Showcase -- Message Extensions are convenient ways to add functionality to Teams. -- This sample adds a search command to the compose area of a chat. -- This sample leverages Teams SSO to acquire a token to call Microsoft Graph APIs. +- Message Extensions are convenient ways to add functionality to Teams. +- This sample adds a search command to the compose area of a chat. +- This sample leverages Teams SSO to acquire a token to call Microsoft Graph APIs. > Note: this is not a chat bot and therefore the bot does not respond if you talk to it. Once it is installed in Teams, you can interact with it by selecting it's app icon in the chat compose area. @@ -53,7 +53,7 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Install the [Teams Toolkit extension](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension) 1. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/python/samples/01.messaging.a.echoBot/README.md b/python/samples/01.messaging.a.echoBot/README.md index 46ad5eb16..32068150d 100644 --- a/python/samples/01.messaging.a.echoBot/README.md +++ b/python/samples/01.messaging.a.echoBot/README.md @@ -22,9 +22,9 @@ You can interact with the bot by messaging it and it will echo that back to you. 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` 1. Follow below instructions to run the sample @@ -37,7 +37,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -47,9 +47,9 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Install [Poetry](https://python-poetry.org/docs/#installation) 1. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. -1. Trigger **Python: Create Environment** from command palette and create a virtual environment +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +1. In the debugger, play the Debug (Edge) script 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. -> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. \ No newline at end of file +> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. diff --git a/python/samples/02.messageExtensions.a.searchCommand/README.md b/python/samples/02.messageExtensions.a.searchCommand/README.md index 03c98e504..17b5ba7f4 100644 --- a/python/samples/02.messageExtensions.a.searchCommand/README.md +++ b/python/samples/02.messageExtensions.a.searchCommand/README.md @@ -6,18 +6,18 @@ This sample shows how to incorporate a basic Message Extension app into a Micros -- [Teams Search Command Message Extension](#teams-search-command-message-extension) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) +- [Teams Search Command Message Extension](#teams-search-command-message-extension) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) ## Interacting with the bot -- Message Extensions are convenient ways to add functionality to Teams. -- This sample adds a search command to the compose area of a chat. +- Message Extensions are convenient ways to add functionality to Teams. +- This sample adds a search command to the compose area of a chat. > Note: this is not a chat bot and therefore the bot does not respond if you talk to it. Once it is installed in Teams, you can interact with it by selecting it's app icon in the chat compose area. @@ -25,9 +25,9 @@ This sample shows how to incorporate a basic Message Extension app into a Micros 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` ## Testing the sample @@ -36,7 +36,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -46,9 +46,9 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 4. Install [Poetry](https://python-poetry.org/docs/#installation) 5. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -7. Ensure that you have set up the sample from the previous step. -8. Trigger **Python: Create Environment** from command palette and create a virtual environment +7. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +8. In the debugger, play the Debug (Edge) script 9. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 10. In the browser that launches, select the **Add** button to install the app to Teams. -> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. \ No newline at end of file +> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. diff --git a/python/samples/03.adaptiveCards.a.typeAheadBot/README.md b/python/samples/03.adaptiveCards.a.typeAheadBot/README.md index 58cda6038..d0c071f9f 100644 --- a/python/samples/03.adaptiveCards.a.typeAheadBot/README.md +++ b/python/samples/03.adaptiveCards.a.typeAheadBot/README.md @@ -6,11 +6,11 @@ This sample shows how to incorporate Adaptive Cards into a Microsoft Teams appli -- [Teams Type-Ahead Bot](#teams-type-ahead-bot) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) +- [Teams Type-Ahead Bot](#teams-type-ahead-bot) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) @@ -24,9 +24,9 @@ You can interact with this bot by sending it a message. Send it a message of `st 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` ## Testing the sample @@ -35,7 +35,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -45,9 +45,9 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 4. Install [Poetry](https://python-poetry.org/docs/#installation) 5. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -7. Ensure that you have set up the sample from the previous step. -8. Trigger **Python: Create Environment** from command palette and create a virtual environment +7. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +8. In the debugger, play the Debug (Edge) script 9. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 10. In the browser that launches, select the **Add** button to install the app to Teams. -> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. \ No newline at end of file +> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. diff --git a/python/samples/04.ai.a.twentyQuestions/README.md b/python/samples/04.ai.a.twentyQuestions/README.md index d4adb9896..5af04641d 100644 --- a/python/samples/04.ai.a.twentyQuestions/README.md +++ b/python/samples/04.ai.a.twentyQuestions/README.md @@ -22,11 +22,11 @@ You can interact with the bot by asking questions to lead towards the secret wor 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` -2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.a.twentyQuestions` folder. Rename the file to `.env`. +2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.a.twentyQuestions` folder. Rename the file to `.env`. 3. If you are using OpenAI then only keep the `OPENAI_KEY` and add in your key. Otherwise if you are using AzureOpenAI then only keep the `AZURE_OPENAI_KEY`, `AZURE_OPENAI_ENDPOINT` variables and fill them in appropriately. @@ -39,7 +39,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -49,9 +49,9 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 4. Install [Poetry](https://python-poetry.org/docs/#installation) 5. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -7. Ensure that you have set up the sample from the previous step. -8. Trigger **Python: Create Environment** from command palette and create a virtual environment +7. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +8. In the debugger, play the Debug (Edge) script 9. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 10. In the browser that launches, select the **Add** button to install the app to Teams. -> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. \ No newline at end of file +> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. diff --git a/python/samples/04.ai.b.messageExtensions.AI-ME/README.md b/python/samples/04.ai.b.messageExtensions.AI-ME/README.md index b295cee03..f9ab24760 100644 --- a/python/samples/04.ai.b.messageExtensions.AI-ME/README.md +++ b/python/samples/04.ai.b.messageExtensions.AI-ME/README.md @@ -1,4 +1,5 @@ # AI in Microsoft Teams Message Extensions: GPT-ME + This sample is a message extension (ME) for Microsoft Teams that leverages the text-davinci-003 model to help users generate and update posts. The extension is designed to assist users in creating posts that are appropriate for a business environment. @@ -21,11 +22,11 @@ This sample illustrates basic ME behavior in Microsoft Teams. The ME is built to 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` -2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.b.messageExtensions.AI-ME` folder. Rename the file to `.env`. +2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.b.messageExtensions.AI-ME` folder. Rename the file to `.env`. 3. If you are using OpenAI then only keep the `OPENAI_KEY` and add in your key. Otherwise if you are using AzureOpenAI then only keep the `AZURE_OPENAI_KEY`, `AZURE_OPENAI_ENDPOINT`variables and fill them in appropriately. @@ -38,7 +39,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -48,9 +49,9 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Install [Poetry](https://python-poetry.org/docs/#installation) 1. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. -1. Trigger **Python: Create Environment** from command palette and create a virtual environment +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +1. In the debugger, play the Debug (Edge) script 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. -> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. \ No newline at end of file +> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. diff --git a/python/samples/04.ai.c.actionMapping.lightBot/README.md b/python/samples/04.ai.c.actionMapping.lightBot/README.md index 54f03ccbc..21360dea9 100644 --- a/python/samples/04.ai.c.actionMapping.lightBot/README.md +++ b/python/samples/04.ai.c.actionMapping.lightBot/README.md @@ -24,11 +24,11 @@ You can interact with the bot by messaging it. 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` -2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.c.actionMapping.lightBot` folder. Rename the file to `.env`. +2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.c.actionMapping.lightBot` folder. Rename the file to `.env`. 3. If you are using OpenAI then only keep the `OPENAI_KEY` and add in your key. Otherwise if you are using AzureOpenAI then only keep the `AZURE_OPENAI_KEY`, `AZURE_OPENAI_ENDPOINT` variables and fill them in appropriately. @@ -41,7 +41,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -51,9 +51,9 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 4. Install [Poetry](https://python-poetry.org/docs/#installation) 5. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -7. Ensure that you have set up the sample from the previous step. -8. Trigger **Python: Create Environment** from command palette and create a virtual environment +7. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +8. In the debugger, play the Debug (Edge) script 9. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 10. In the browser that launches, select the **Add** button to install the app to Teams. -> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. \ No newline at end of file +> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. diff --git a/python/samples/04.ai.d.chainedActions.listBot/README.md b/python/samples/04.ai.d.chainedActions.listBot/README.md index fb2373b92..26192b928 100644 --- a/python/samples/04.ai.d.chainedActions.listBot/README.md +++ b/python/samples/04.ai.d.chainedActions.listBot/README.md @@ -22,11 +22,11 @@ You can interact with the bot by asking for a summary of the list, adding new it 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` -2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.d.chainedActions.listBot` folder. Rename the file to `.env`. +2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.d.chainedActions.listBot` folder. Rename the file to `.env`. 3. If you are using OpenAI then only keep the `OPENAI_KEY` and add in your key. Otherwise if you are using AzureOpenAI then only keep the `AZURE_OPENAI_KEY`, `AZURE_OPENAI_ENDPOINT` variables and fill them in appropriately. @@ -39,7 +39,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -49,9 +49,9 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 4. Install [Poetry](https://python-poetry.org/docs/#installation) 5. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -7. Ensure that you have set up the sample from the previous step. -8. Trigger **Python: Create Environment** from command palette and create a virtual environment +7. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +8. In the debugger, play the Debug (Edge) script 9. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 10. In the browser that launches, select the **Add** button to install the app to Teams. -> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. \ No newline at end of file +> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. diff --git a/python/samples/04.ai.e.chainedActions.devOpsBot/README.md b/python/samples/04.ai.e.chainedActions.devOpsBot/README.md index db6d8fb59..bb021c382 100644 --- a/python/samples/04.ai.e.chainedActions.devOpsBot/README.md +++ b/python/samples/04.ai.e.chainedActions.devOpsBot/README.md @@ -20,23 +20,23 @@ You can interact with this bot by sending it a message. The bot will respond to 1. **create work item to track new functionality in Adaptive card and assign it to John** -- **Result:** The bot will create a tracking item in Azure DevOps and assign it to John -- **Valid Scopes:** personal, group chat, team chat +- **Result:** The bot will create a tracking item in Azure DevOps and assign it to John +- **Valid Scopes:** personal, group chat, team chat 2. **update title of work item 1 to create a new bot in azure** -- **Result:** The bot will update the title of work item 1 to create a new bot in azure. -- **Valid Scopes:** personal, group chat, team chat +- **Result:** The bot will update the title of work item 1 to create a new bot in azure. +- **Valid Scopes:** personal, group chat, team chat 3. **triage work item 1 as "in progress"** -- **Result:** The bot will update the state of work item 1 to "in progress". -- **Valid Scopes:** personal, group chat, team chat +- **Result:** The bot will update the state of work item 1 to "in progress". +- **Valid Scopes:** personal, group chat, team chat 4. **summarize work items"** -- **Result:** The bot will summarize the work items and respond back with an adaptive card. -- **Valid Scopes:** personal, group chat, team chat +- **Result:** The bot will summarize the work items and respond back with an adaptive card. +- **Valid Scopes:** personal, group chat, team chat You can select an option from the command list by typing `@TeamsConversationBot` into the compose message area and `What can I do?` text above the compose area. @@ -44,11 +44,11 @@ You can select an option from the command list by typing `@TeamsConversationBot` 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` -2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.e.chainedActions.devOpsBot` folder. Rename the file to `.env`. +2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.e.chainedActions.devOpsBot` folder. Rename the file to `.env`. 3. If you are using OpenAI then only keep the `OPENAI_KEY` and add in your key. Otherwise if you are using AzureOpenAI then only keep the `AZURE_OPENAI_KEY`, `AZURE_OPENAI_ENDPOINT` variables and fill them in appropriately. @@ -61,7 +61,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -71,9 +71,9 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 4. Install [Poetry](https://python-poetry.org/docs/#installation) 5. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -7. Ensure that you have set up the sample from the previous step. -8. Trigger **Python: Create Environment** from command palette and create a virtual environment +7. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +8. In the debugger, play the Debug (Edge) script 9. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 10. In the browser that launches, select the **Add** button to install the app to Teams. -> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. \ No newline at end of file +> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. diff --git a/python/samples/04.ai.f.dataSource.azureOpenAI/README.md b/python/samples/04.ai.f.dataSource.azureOpenAI/README.md index 3927d591e..800a83a50 100644 --- a/python/samples/04.ai.f.dataSource.azureOpenAI/README.md +++ b/python/samples/04.ai.f.dataSource.azureOpenAI/README.md @@ -58,7 +58,7 @@ The Azure OpenAI OYD configuration can be added to the prompt templates `config. "authentication": { "type": 'system_assigned_managed_identity' } - } + } } ] }, @@ -94,7 +94,7 @@ async def get_default_prompt(context: TurnContext, state: AppTurnState, planner: "authentication": { "type": 'system_assigned_managed_identity' } - } + } } ] @@ -118,17 +118,16 @@ ActionPlannerOptions(model=model, prompts=prompts, default_prompt=get_default_pr 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` -2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.f.dataSource.azureOpenAI` folder. Rename the file to `.env`. +2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.f.dataSource.azureOpenAI` folder. Rename the file to `.env`. 3. Fill the `AZURE_OPENAI_ENDPOINT`, `AZURE_SEARCH_ENDPOINT`, and `AZURE_SEARCH_INDEX` variables appropriately. 4. Follow the [use your data quickstart instructions](https://learn.microsoft.com/en-us/azure/ai-services/openai/use-your-data-quickstart?tabs=command-line%2Cpython-new&pivots=programming-language-studio#add-your-data-using-azure-openai-studio) to add your data using Azure OpenAI Studio. Select `Upload files` as the data source. You can upload the `nba.pdf` file. Take note of the index name. - ## Testing the sample The easiest and fastest way to get up and running is with Teams Toolkit as your development guide. To use Teams Toolkit to automate setup and debugging, please [continue below](#using-teams-toolkit-for-visual-studio-code). @@ -136,7 +135,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -147,8 +146,8 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Install [Poetry](https://python-poetry.org/docs/#installation) 1. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. -1. Trigger **Python: Create Environment** from command palette and create a virtual environment +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +1. In the debugger, play the Debug (Edge) script 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/python/samples/04.ai.g.autogen.product-spec-critique/README.md b/python/samples/04.ai.g.autogen.product-spec-critique/README.md index 8d5917be7..ccdf4b3a4 100644 --- a/python/samples/04.ai.g.autogen.product-spec-critique/README.md +++ b/python/samples/04.ai.g.autogen.product-spec-critique/README.md @@ -1,9 +1,10 @@ ## Teams Autogen Bot This is a simple project that demonstrates the use of [autogen](https://github.com/microsoft/autogen) in the context of a Microsoft Teams AI bot. -This bot models a product-spec critiquing team. +This bot models a product-spec critiquing team. The team consists of: + 1. A questioner agent - the role of this agent is to ask questions based on some criteria for product specs at a company. 2. An answerer agent - the role of this agent is to answer the questions asked by the questioner agent based on a product spec 3. An evaluator agent - the role of this agent is to evaluate the answers given by the answerer agent based on the criteria given by the questioner agent. @@ -32,11 +33,11 @@ You can interact with the bot by messaging it. 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` -2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.g.autogen.product-spec-critique` folder. Rename the file to `.env`. +2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.g.autogen.product-spec-critique` folder. Rename the file to `.env`. 3. Update .env. Make sure it includes either `OPENAI_KEY` or `AZURE_OPENAI_API_KEY` with `AZURE_OPENAI_ENDPOINT`. If you look for `build_llm_config` in the code, you will see how it builds the config for the model. You may need to modify it to suit your needs. @@ -47,7 +48,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [Bot Framework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -57,8 +58,8 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 4. Install [Poetry](https://python-poetry.org/docs/#installation) 5. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -7. Ensure that you have set up the sample from the previous step. -8. Trigger **Python: Create Environment** from command palette and create a virtual environment +7. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +8. In the debugger, play the Debug (Edge) script 9. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 10. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/python/samples/04.ai.h.chainedActions.listBot-streaming/README.md b/python/samples/04.ai.h.chainedActions.listBot-streaming/README.md index fb2373b92..26192b928 100644 --- a/python/samples/04.ai.h.chainedActions.listBot-streaming/README.md +++ b/python/samples/04.ai.h.chainedActions.listBot-streaming/README.md @@ -22,11 +22,11 @@ You can interact with the bot by asking for a summary of the list, adding new it 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` -2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.d.chainedActions.listBot` folder. Rename the file to `.env`. +2. Duplicate the `sample.env` in the `teams-ai/python/samples/04.ai.d.chainedActions.listBot` folder. Rename the file to `.env`. 3. If you are using OpenAI then only keep the `OPENAI_KEY` and add in your key. Otherwise if you are using AzureOpenAI then only keep the `AZURE_OPENAI_KEY`, `AZURE_OPENAI_ENDPOINT` variables and fill them in appropriately. @@ -39,7 +39,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -49,9 +49,9 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 4. Install [Poetry](https://python-poetry.org/docs/#installation) 5. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -7. Ensure that you have set up the sample from the previous step. -8. Trigger **Python: Create Environment** from command palette and create a virtual environment +7. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +8. In the debugger, play the Debug (Edge) script 9. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 10. In the browser that launches, select the **Add** button to install the app to Teams. -> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. \ No newline at end of file +> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. diff --git a/python/samples/05.chatModeration/README.md b/python/samples/05.chatModeration/README.md index 4f87897be..abf572b99 100644 --- a/python/samples/05.chatModeration/README.md +++ b/python/samples/05.chatModeration/README.md @@ -22,11 +22,11 @@ You can interact with the bot by messaging it. 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` -2. Duplicate the `sample.env` in the `teams-ai/python/samples/05.chatModeration` folder. Rename the file to `.env`. +2. Duplicate the `sample.env` in the `teams-ai/python/samples/05.chatModeration` folder. Rename the file to `.env`. 3. If you are using OpenAI then only keep the `OPENAI_KEY` and add in your key. Otherwise if you are using AzureOpenAI then only keep the `AZURE_OPENAI_KEY`, `AZURE_OPENAI_ENDPOINT`, `AZURE_CONTENT_SAFETY_KEY`, and `AZURE_CONTENT_SAFETY_ENDPOINT` variables and fill them in appropriately. @@ -39,7 +39,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -49,9 +49,9 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 4. Install [Poetry](https://python-poetry.org/docs/#installation) 5. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -8. Ensure that you have set up the sample from the previous step. -9. Trigger **Python: Create Environment** from command palette and create a virtual environment -10. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. -11. In the browser that launches, select the **Add** button to install the app to Teams. +7. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +8. In the debugger, play the Debug (Edge) script +9. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. +10. In the browser that launches, select the **Add** button to install the app to Teams. -> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. \ No newline at end of file +> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. diff --git a/python/samples/06.assistants.a.mathBot/README.md b/python/samples/06.assistants.a.mathBot/README.md index f5a36242b..d0d7d289c 100644 --- a/python/samples/06.assistants.a.mathBot/README.md +++ b/python/samples/06.assistants.a.mathBot/README.md @@ -22,11 +22,11 @@ You can interact with the bot by messaging it. 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` -2. Duplicate the `sample.env` in the `teams-ai/python/samples/06.assistants.a.mathBot` folder. Rename the file to `.env`. +2. Duplicate the `sample.env` in the `teams-ai/python/samples/06.assistants.a.mathBot` folder. Rename the file to `.env`. 3. If you are using OpenAI then only keep the `OPENAI_KEY` and add in your key. Otherwise if you are using AzureOpenAI then only keep the `AZURE_OPENAI_KEY`, `AZURE_OPENAI_ENDPOINT` variables and fill them in appropriately. @@ -41,7 +41,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -51,9 +51,9 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 4. Install [Poetry](https://python-poetry.org/docs/#installation) 5. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -7. Ensure that you have set up the sample from the previous step. -8. Trigger **Python: Create Environment** from command palette and create a virtual environment +7. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +8. In the debugger, play the Debug (Edge) script 9. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 10. In the browser that launches, select the **Add** button to install the app to Teams. -> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. \ No newline at end of file +> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. diff --git a/python/samples/06.assistants.b.orderBot/README.md b/python/samples/06.assistants.b.orderBot/README.md index 11f5f3eac..f4dee3c85 100644 --- a/python/samples/06.assistants.b.orderBot/README.md +++ b/python/samples/06.assistants.b.orderBot/README.md @@ -22,11 +22,11 @@ You can interact with this bot by sending it a message, and the bot will reply t 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` -2. Duplicate the `sample.env` in the `teams-ai/python/samples/06.assistants.b.orderBot` folder. Rename the file to `.env`. +2. Duplicate the `sample.env` in the `teams-ai/python/samples/06.assistants.b.orderBot` folder. Rename the file to `.env`. 3. If you are using OpenAI then only keep the `OPENAI_KEY` and add in your key. Otherwise if you are using AzureOpenAI then only keep the `AZURE_OPENAI_KEY`, `AZURE_OPENAI_ENDPOINT` variables and fill them in appropriately. @@ -41,7 +41,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -51,9 +51,9 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 4. Install [Poetry](https://python-poetry.org/docs/#installation) 5. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -7. Ensure that you have set up the sample from the previous step. -8. Trigger **Python: Create Environment** from command palette and create a virtual environment +7. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +8. In the debugger, play the Debug (Edge) script 9. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 10. In the browser that launches, select the **Add** button to install the app to Teams. -> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. \ No newline at end of file +> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. diff --git a/python/samples/06.auth.oauth.bot/README.md b/python/samples/06.auth.oauth.bot/README.md index 56d06d923..acbcacac7 100644 --- a/python/samples/06.auth.oauth.bot/README.md +++ b/python/samples/06.auth.oauth.bot/README.md @@ -6,17 +6,17 @@ This sample requires creating an OAuth Connection in Azure Bot Service, which pr Note that this bot will only work in tenants where the following graph scopes are permitted: -- `User.Read` +- `User.Read` -- [OAuth Bot](#oauth-bot) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) +- [OAuth Bot](#oauth-bot) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) @@ -24,14 +24,13 @@ Note that this bot will only work in tenants where the following graph scopes ar You can interact with this bot by sending it a message, which will echo back to you. - ## Setting up the sample 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` 2. Duplicate the `sample.env`. Rename the file to .env and fill in the variables with your keys. @@ -44,7 +43,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -54,8 +53,8 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Install [Poetry](https://python-poetry.org/docs/#installation) 1. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. -1. Trigger **Python: Create Environment** from command palette and create a virtual environment +1. Ensure that you are showing as logged in in the sample window. +1. In the debugger, play the Debug (Edge) script 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. diff --git a/python/samples/06.auth.oauth.bot/poetry.lock b/python/samples/06.auth.oauth.bot/poetry.lock index bde8763eb..51d17e974 100644 --- a/python/samples/06.auth.oauth.bot/poetry.lock +++ b/python/samples/06.auth.oauth.bot/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.8.4 and should not be changed by hand. [[package]] name = "aiohttp" @@ -1017,6 +1017,91 @@ files = [ [package.extras] colors = ["colorama (>=0.4.6)"] +[[package]] +name = "jiter" +version = "0.8.2" +description = "Fast iterable JSON parser." +optional = false +python-versions = ">=3.8" +files = [ + {file = "jiter-0.8.2-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:ca8577f6a413abe29b079bc30f907894d7eb07a865c4df69475e868d73e71c7b"}, + {file = "jiter-0.8.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:b25bd626bde7fb51534190c7e3cb97cee89ee76b76d7585580e22f34f5e3f393"}, + {file = "jiter-0.8.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d5c826a221851a8dc028eb6d7d6429ba03184fa3c7e83ae01cd6d3bd1d4bd17d"}, + {file = "jiter-0.8.2-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d35c864c2dff13dfd79fb070fc4fc6235d7b9b359efe340e1261deb21b9fcb66"}, + {file = "jiter-0.8.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f557c55bc2b7676e74d39d19bcb8775ca295c7a028246175d6a8b431e70835e5"}, + {file = "jiter-0.8.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:580ccf358539153db147e40751a0b41688a5ceb275e6f3e93d91c9467f42b2e3"}, + {file = "jiter-0.8.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:af102d3372e917cffce49b521e4c32c497515119dc7bd8a75665e90a718bbf08"}, + {file = "jiter-0.8.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:cadcc978f82397d515bb2683fc0d50103acff2a180552654bb92d6045dec2c49"}, + {file = "jiter-0.8.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:ba5bdf56969cad2019d4e8ffd3f879b5fdc792624129741d3d83fc832fef8c7d"}, + {file = "jiter-0.8.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:3b94a33a241bee9e34b8481cdcaa3d5c2116f575e0226e421bed3f7a6ea71cff"}, + {file = "jiter-0.8.2-cp310-cp310-win32.whl", hash = "sha256:6e5337bf454abddd91bd048ce0dca5134056fc99ca0205258766db35d0a2ea43"}, + {file = "jiter-0.8.2-cp310-cp310-win_amd64.whl", hash = "sha256:4a9220497ca0cb1fe94e3f334f65b9b5102a0b8147646118f020d8ce1de70105"}, + {file = "jiter-0.8.2-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:2dd61c5afc88a4fda7d8b2cf03ae5947c6ac7516d32b7a15bf4b49569a5c076b"}, + {file = "jiter-0.8.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:a6c710d657c8d1d2adbbb5c0b0c6bfcec28fd35bd6b5f016395f9ac43e878a15"}, + {file = "jiter-0.8.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a9584de0cd306072635fe4b89742bf26feae858a0683b399ad0c2509011b9dc0"}, + {file = "jiter-0.8.2-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5a90a923338531b7970abb063cfc087eebae6ef8ec8139762007188f6bc69a9f"}, + {file = "jiter-0.8.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d21974d246ed0181558087cd9f76e84e8321091ebfb3a93d4c341479a736f099"}, + {file = "jiter-0.8.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:32475a42b2ea7b344069dc1e81445cfc00b9d0e3ca837f0523072432332e9f74"}, + {file = "jiter-0.8.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8b9931fd36ee513c26b5bf08c940b0ac875de175341cbdd4fa3be109f0492586"}, + {file = "jiter-0.8.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:ce0820f4a3a59ddced7fce696d86a096d5cc48d32a4183483a17671a61edfddc"}, + {file = "jiter-0.8.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:8ffc86ae5e3e6a93765d49d1ab47b6075a9c978a2b3b80f0f32628f39caa0c88"}, + {file = "jiter-0.8.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:5127dc1abd809431172bc3fbe8168d6b90556a30bb10acd5ded41c3cfd6f43b6"}, + {file = "jiter-0.8.2-cp311-cp311-win32.whl", hash = "sha256:66227a2c7b575720c1871c8800d3a0122bb8ee94edb43a5685aa9aceb2782d44"}, + {file = "jiter-0.8.2-cp311-cp311-win_amd64.whl", hash = "sha256:cde031d8413842a1e7501e9129b8e676e62a657f8ec8166e18a70d94d4682855"}, + {file = "jiter-0.8.2-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:e6ec2be506e7d6f9527dae9ff4b7f54e68ea44a0ef6b098256ddf895218a2f8f"}, + {file = "jiter-0.8.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:76e324da7b5da060287c54f2fabd3db5f76468006c811831f051942bf68c9d44"}, + {file = "jiter-0.8.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:180a8aea058f7535d1c84183c0362c710f4750bef66630c05f40c93c2b152a0f"}, + {file = "jiter-0.8.2-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:025337859077b41548bdcbabe38698bcd93cfe10b06ff66617a48ff92c9aec60"}, + {file = "jiter-0.8.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ecff0dc14f409599bbcafa7e470c00b80f17abc14d1405d38ab02e4b42e55b57"}, + {file = "jiter-0.8.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:ffd9fee7d0775ebaba131f7ca2e2d83839a62ad65e8e02fe2bd8fc975cedeb9e"}, + {file = "jiter-0.8.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:14601dcac4889e0a1c75ccf6a0e4baf70dbc75041e51bcf8d0e9274519df6887"}, + {file = "jiter-0.8.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:92249669925bc1c54fcd2ec73f70f2c1d6a817928480ee1c65af5f6b81cdf12d"}, + {file = "jiter-0.8.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:e725edd0929fa79f8349ab4ec7f81c714df51dc4e991539a578e5018fa4a7152"}, + {file = "jiter-0.8.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:bf55846c7b7a680eebaf9c3c48d630e1bf51bdf76c68a5f654b8524335b0ad29"}, + {file = "jiter-0.8.2-cp312-cp312-win32.whl", hash = "sha256:7efe4853ecd3d6110301665a5178b9856be7e2a9485f49d91aa4d737ad2ae49e"}, + {file = "jiter-0.8.2-cp312-cp312-win_amd64.whl", hash = "sha256:83c0efd80b29695058d0fd2fa8a556490dbce9804eac3e281f373bbc99045f6c"}, + {file = "jiter-0.8.2-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:ca1f08b8e43dc3bd0594c992fb1fd2f7ce87f7bf0d44358198d6da8034afdf84"}, + {file = "jiter-0.8.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:5672a86d55416ccd214c778efccf3266b84f87b89063b582167d803246354be4"}, + {file = "jiter-0.8.2-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:58dc9bc9767a1101f4e5e22db1b652161a225874d66f0e5cb8e2c7d1c438b587"}, + {file = "jiter-0.8.2-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:37b2998606d6dadbb5ccda959a33d6a5e853252d921fec1792fc902351bb4e2c"}, + {file = "jiter-0.8.2-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4ab9a87f3784eb0e098f84a32670cfe4a79cb6512fd8f42ae3d0709f06405d18"}, + {file = "jiter-0.8.2-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:79aec8172b9e3c6d05fd4b219d5de1ac616bd8da934107325a6c0d0e866a21b6"}, + {file = "jiter-0.8.2-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:711e408732d4e9a0208008e5892c2966b485c783cd2d9a681f3eb147cf36c7ef"}, + {file = "jiter-0.8.2-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:653cf462db4e8c41995e33d865965e79641ef45369d8a11f54cd30888b7e6ff1"}, + {file = "jiter-0.8.2-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:9c63eaef32b7bebac8ebebf4dabebdbc6769a09c127294db6babee38e9f405b9"}, + {file = "jiter-0.8.2-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:eb21aaa9a200d0a80dacc7a81038d2e476ffe473ffdd9c91eb745d623561de05"}, + {file = "jiter-0.8.2-cp313-cp313-win32.whl", hash = "sha256:789361ed945d8d42850f919342a8665d2dc79e7e44ca1c97cc786966a21f627a"}, + {file = "jiter-0.8.2-cp313-cp313-win_amd64.whl", hash = "sha256:ab7f43235d71e03b941c1630f4b6e3055d46b6cb8728a17663eaac9d8e83a865"}, + {file = "jiter-0.8.2-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:b426f72cd77da3fec300ed3bc990895e2dd6b49e3bfe6c438592a3ba660e41ca"}, + {file = "jiter-0.8.2-cp313-cp313t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b2dd880785088ff2ad21ffee205e58a8c1ddabc63612444ae41e5e4b321b39c0"}, + {file = "jiter-0.8.2-cp313-cp313t-win_amd64.whl", hash = "sha256:3ac9f578c46f22405ff7f8b1f5848fb753cc4b8377fbec8470a7dc3997ca7566"}, + {file = "jiter-0.8.2-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:9e1fa156ee9454642adb7e7234a383884452532bc9d53d5af2d18d98ada1d79c"}, + {file = "jiter-0.8.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:0cf5dfa9956d96ff2efb0f8e9c7d055904012c952539a774305aaaf3abdf3d6c"}, + {file = "jiter-0.8.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e52bf98c7e727dd44f7c4acb980cb988448faeafed8433c867888268899b298b"}, + {file = "jiter-0.8.2-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:a2ecaa3c23e7a7cf86d00eda3390c232f4d533cd9ddea4b04f5d0644faf642c5"}, + {file = "jiter-0.8.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:08d4c92bf480e19fc3f2717c9ce2aa31dceaa9163839a311424b6862252c943e"}, + {file = "jiter-0.8.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:99d9a1eded738299ba8e106c6779ce5c3893cffa0e32e4485d680588adae6db8"}, + {file = "jiter-0.8.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d20be8b7f606df096e08b0b1b4a3c6f0515e8dac296881fe7461dfa0fb5ec817"}, + {file = "jiter-0.8.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d33f94615fcaf872f7fd8cd98ac3b429e435c77619777e8a449d9d27e01134d1"}, + {file = "jiter-0.8.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:317b25e98a35ffec5c67efe56a4e9970852632c810d35b34ecdd70cc0e47b3b6"}, + {file = "jiter-0.8.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:fc9043259ee430ecd71d178fccabd8c332a3bf1e81e50cae43cc2b28d19e4cb7"}, + {file = "jiter-0.8.2-cp38-cp38-win32.whl", hash = "sha256:fc5adda618205bd4678b146612ce44c3cbfdee9697951f2c0ffdef1f26d72b63"}, + {file = "jiter-0.8.2-cp38-cp38-win_amd64.whl", hash = "sha256:cd646c827b4f85ef4a78e4e58f4f5854fae0caf3db91b59f0d73731448a970c6"}, + {file = "jiter-0.8.2-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:e41e75344acef3fc59ba4765df29f107f309ca9e8eace5baacabd9217e52a5ee"}, + {file = "jiter-0.8.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:7f22b16b35d5c1df9dfd58843ab2cd25e6bf15191f5a236bed177afade507bfc"}, + {file = "jiter-0.8.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f7200b8f7619d36aa51c803fd52020a2dfbea36ffec1b5e22cab11fd34d95a6d"}, + {file = "jiter-0.8.2-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:70bf4c43652cc294040dbb62256c83c8718370c8b93dd93d934b9a7bf6c4f53c"}, + {file = "jiter-0.8.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f9d471356dc16f84ed48768b8ee79f29514295c7295cb41e1133ec0b2b8d637d"}, + {file = "jiter-0.8.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:859e8eb3507894093d01929e12e267f83b1d5f6221099d3ec976f0c995cb6bd9"}, + {file = "jiter-0.8.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:eaa58399c01db555346647a907b4ef6d4f584b123943be6ed5588c3f2359c9f4"}, + {file = "jiter-0.8.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:8f2d5ed877f089862f4c7aacf3a542627c1496f972a34d0474ce85ee7d939c27"}, + {file = "jiter-0.8.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:03c9df035d4f8d647f8c210ddc2ae0728387275340668fb30d2421e17d9a0841"}, + {file = "jiter-0.8.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:8bd2a824d08d8977bb2794ea2682f898ad3d8837932e3a74937e93d62ecbb637"}, + {file = "jiter-0.8.2-cp39-cp39-win32.whl", hash = "sha256:ca29b6371ebc40e496995c94b988a101b9fbbed48a51190a4461fcb0a68b4a36"}, + {file = "jiter-0.8.2-cp39-cp39-win_amd64.whl", hash = "sha256:1c0dfbd1be3cbefc7510102370d86e35d1d53e5a93d48519688b1bf0f761160a"}, + {file = "jiter-0.8.2.tar.gz", hash = "sha256:cd73d3e740666d0e639f678adb176fad25c1bcbdae88d8d7b857e1783bb4212d"}, +] + [[package]] name = "jsonpickle" version = "1.4.2" @@ -1373,23 +1458,24 @@ signedtoken = ["cryptography (>=3.0.0)", "pyjwt (>=2.0.0,<3)"] [[package]] name = "openai" -version = "1.35.10" +version = "1.57.1" description = "The official Python library for the openai API" optional = false -python-versions = ">=3.7.1" +python-versions = ">=3.8" files = [ - {file = "openai-1.35.10-py3-none-any.whl", hash = "sha256:962cb5c23224b5cbd16078308dabab97a08b0a5ad736a4fdb3dc2ffc44ac974f"}, - {file = "openai-1.35.10.tar.gz", hash = "sha256:85966949f4f960f3e4b239a659f9fd64d3a97ecc43c44dc0a044b5c7f11cccc6"}, + {file = "openai-1.57.1-py3-none-any.whl", hash = "sha256:3865686c927e93492d1145938d4a24b634951531c4b2769d43ca5dbd4b25d8fd"}, + {file = "openai-1.57.1.tar.gz", hash = "sha256:a95f22e04ab3df26e64a15d958342265e802314131275908b3b3e36f8c5d4377"}, ] [package.dependencies] anyio = ">=3.5.0,<5" distro = ">=1.7.0,<2" httpx = ">=0.23.0,<1" +jiter = ">=0.4.0,<1" pydantic = ">=1.9.0,<3" sniffio = "*" tqdm = ">4" -typing-extensions = ">=4.7,<5" +typing-extensions = ">=4.11,<5" [package.extras] datalib = ["numpy (>=1)", "pandas (>=1.2.3)", "pandas-stubs (>=1.1.0.11)"] @@ -2138,13 +2224,13 @@ files = [ [[package]] name = "teams-ai" -version = "1.2.2" +version = "1.5.0" description = "SDK focused on building AI based applications for Microsoft Teams." optional = false python-versions = "<4.0,>=3.8" files = [ - {file = "teams_ai-1.2.2-py3-none-any.whl", hash = "sha256:1914b5dccf12385a8aa493e10ea02a81555afa174d73fd10ecfd501541753ab3"}, - {file = "teams_ai-1.2.2.tar.gz", hash = "sha256:0eba0002735f412a0d101a3b2044c227ceebe3641744b1f48ad07e236dd8a3b4"}, + {file = "teams_ai-1.5.0-py3-none-any.whl", hash = "sha256:7bbf16244ef0471329fafe89a21bf35afb7bd03cdcdf5efb05048dddb5789464"}, + {file = "teams_ai-1.5.0.tar.gz", hash = "sha256:8a4f6b809633a88459a8c20315e324a9609732aea728e1ef316342e628203149"}, ] [package.dependencies] @@ -2157,7 +2243,7 @@ botframework-connector = ">=4.15.0,<5.0.0" dataclasses-json = ">=0.6.4,<0.7.0" jsonschema = ">=4.21.1,<5.0.0" msal = ">=1.28.0,<2.0.0" -openai = ">=1.27.0,<2.0.0" +openai = ">=v1.52.0,<2.0.0" pyyaml = ">=6.0.1,<7.0.0" tiktoken = ">=0.7.0,<0.8.0" types-pyyaml = ">=6.0.12.12,<7.0.0.0" @@ -2509,4 +2595,4 @@ test = ["big-O", "importlib-resources", "jaraco.functools", "jaraco.itertools", [metadata] lock-version = "2.0" python-versions = ">=3.8,<4.0" -content-hash = "ea9096124101780e63bbbe3c2b354793e856f04516986e991729aecf8c1a72fb" +content-hash = "d27aeae755ac1b8f04568c8752cb69ceafb09cef140e5224f3614549418b4da4" diff --git a/python/samples/06.auth.oauth.messageExtensions/README.md b/python/samples/06.auth.oauth.messageExtensions/README.md index 552d300e3..0ba16c99f 100644 --- a/python/samples/06.auth.oauth.messageExtensions/README.md +++ b/python/samples/06.auth.oauth.messageExtensions/README.md @@ -6,17 +6,17 @@ This sample requires creating an OAuth Connection in Azure Bot Service, which pr Note that this bot will only work in tenants where the following graph scopes are permitted: -- `User.Read` +- `User.Read` -- [Teams Message Extension Oauth Bot](#teams-message-extension-oauth-bot) - - [Interacting with the bot](#interacting-with-the-bot) - - [Setting up the sample](#setting-up-the-sample) - - [Testing the sample](#testing-the-sample) - - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) +- [Teams Message Extension Oauth Bot](#teams-message-extension-oauth-bot) + - [Interacting with the bot](#interacting-with-the-bot) + - [Setting up the sample](#setting-up-the-sample) + - [Testing the sample](#testing-the-sample) + - [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code) @@ -28,9 +28,9 @@ Note that this bot will only work in tenants where the following graph scopes ar 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` 2. Duplicate the `sample.env`. Rename the file to .env and fill in the variables with your keys. @@ -43,7 +43,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -53,9 +53,9 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Install [Poetry](https://python-poetry.org/docs/#installation) 1. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. -1. Trigger **Python: Create Environment** from command palette and create a virtual environment +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +1. In the debugger, play the Debug (Edge) script 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. -> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. \ No newline at end of file +> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. diff --git a/python/samples/07.planners.a.langchain/README.md b/python/samples/07.planners.a.langchain/README.md index 725370273..0898cb484 100644 --- a/python/samples/07.planners.a.langchain/README.md +++ b/python/samples/07.planners.a.langchain/README.md @@ -24,11 +24,11 @@ You can interact with the bot by messaging it. 1. Clone the repository - ```bash - git clone https://github.com/Microsoft/teams-ai.git - ``` + ```bash + git clone https://github.com/Microsoft/teams-ai.git + ``` -2. Duplicate the `sample.env` in the `teams-ai/python/samples/07.planners.a.langchain` folder. Rename the file to `.env`. +2. Duplicate the `sample.env` in the `teams-ai/python/samples/07.planners.a.langchain` folder. Rename the file to `.env`. 3. If you are using OpenAI then only keep the `OPENAI_KEY` and add in your key. Otherwise if you are using AzureOpenAI then only keep the `AZURE_OPENAI_KEY`, `AZURE_OPENAI_ENDPOINT` variables and fill them in appropriately. @@ -41,7 +41,7 @@ The easiest and fastest way to get up and running is with Teams Toolkit as your Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section. For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test) -### Using Teams Toolkit for Visual Studio Code +### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -51,9 +51,9 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 4. Install [Poetry](https://python-poetry.org/docs/#installation) 5. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -7. Ensure that you have set up the sample from the previous step. -8. Trigger **Python: Create Environment** from command palette and create a virtual environment +7. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +8. In the debugger, play the Debug (Edge) script 9. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 10. In the browser that launches, select the **Add** button to install the app to Teams. -> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. \ No newline at end of file +> If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams. diff --git a/python/samples/README.md b/python/samples/README.md index b78009cc3..6af06fe31 100644 --- a/python/samples/README.md +++ b/python/samples/README.md @@ -4,11 +4,10 @@ In this folder, you will find various examples showcasing the different capabili ## Appendix -It is recommended to use the Teams Toolkit for Visual Studio Code way to test a sample. +It is recommended to use the Teams Toolkit for Visual Studio Code way to test a sample. The easiest and fastest way to get up and running is with Teams Toolkit as your development guide. To use Teams Toolkit to automate setup and debugging, please [continue below](#using-teams-toolkit-for-visual-studio-code). - #### Using Teams Toolkit for Visual Studio Code The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code. @@ -19,8 +18,8 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual 1. Install [Poetry](https://python-poetry.org/docs/#installation) 1. Select **File > Open Folder** in VS Code and choose this sample's directory from the repo 1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps -1. Ensure that you have set up the sample from the previous step. -1. Trigger **Python: Create Environment** from command palette and create a virtual environment +1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step. +1. In the debugger, play the Debug (Edge) script 1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client. 1. In the browser that launches, select the **Add** button to install the app to Teams. @@ -28,5 +27,5 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual ### Further reading -- [Teams Toolkit overview](https://learn.microsoft.com/en-us/microsoftteams/platform/toolkit/teams-toolkit-fundamentals) -- [How Microsoft Teams bots work](https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-basics-teams?view=azure-bot-service-4.0&tabs=javascript) +- [Teams Toolkit overview](https://learn.microsoft.com/en-us/microsoftteams/platform/toolkit/teams-toolkit-fundamentals) +- [How Microsoft Teams bots work](https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-basics-teams?view=azure-bot-service-4.0&tabs=javascript)