Added the SpeechRelay Bot sample building upon RelayBot sample with DirectLine Speech

RelayBotSample/README.md

@@ -18,10 +18,9 @@ This bot has been created based on [Bot Framework](https://dev.botframework.com)
 - Clone the repository
 
     ```bash
-    git clone https://github.com/microsoft/PowerVirtualAgentsSample.git
+    git clone clone https://github.com/microsoft/CopilotStudioSamples.git
+    cd RelayBotSample
     ```
-
-- In a terminal, navigate to `BYOBSample/`
 - Update file appsettings.json with your Power Virtual Agent bot id, tenant id, bot name and other settings.
 
     To retrieve your bot's bot ID and tenant ID, click on left side pane's ***Manage***, click ***Channels*** and click on the Azure Bot Service channel that you need to connect to.

SpeechRelayBotSample/DeploymentTemplates/CopilotSpeechBot_ResourceDeployment.azcli

@@ -0,0 +1,53 @@
+# Assign values to variables
+$ressourceGroup="CopilotSpeechSample"
+$location="westeurope"
+$appServiceName="CopilotSpeechBotAppPlan"
+$webAppName="CopilotSpeechBotWebApp"
+$cognitiveServiceAccountName="CopilotSpeechBotAIService"
+$botName="CopilotSpeechBot"
+$appRegistrationName="CopilotSpeechBotPrincipal"
+$tenantId="<Tenant ID>"
+$webAppEndoint=echo https://$webAppName.azurewebsites.net/api/messages
+$subscriptionId=<ID from az account set output>
+
+az login
+az account set --subscription $subscriptionId
+##Create speech services
+az group create --location westeurope --name $ressourceGroup
+az cognitiveservices account create -n $cognitiveServiceAccountName -g $ressourceGroup --kind SpeechServices --sku F0 -l $location --yes
+$cognitiveServicesKey=$(az cognitiveservices account keys list -n $cognitiveServiceAccountName -g $ressourceGroup --query "key1")
+
+##Create app plan and web app
+az appservice plan create -g $ressourceGroup -n $appServiceName --sku F1 --location $location
+az webapp create -g $ressourceGroup -n $webAppName -p $appServiceName
+
+#Enable web sockets on the app
+az webapp config set -g $ressourceGroup -n $webAppName --web-sockets-enabled true
+#Create app registration entry
+$appId = $(az ad app create --display-name $appRegistrationName --query "appId")
+#Create bot
+az bot create -g $ressourceGroup -n $botName --app-type SingleTenant --appid $appId --tenant-id $tenantId
+#Set bot endpoint to web app path
+az bot update -g $ressourceGroup -n $botName --endpoint $webAppEndoint
+#Add DL speech channel and enable streaming endpoint in the Azure Portal
+
+######################### Deploy bot source
+
+#Clone Echo bot sample
+git clone https://github.com/microsoft/CopilotStudioSamples.git
+cd RelayBotSample
+#Build
+dotnet build -c release .\SampleBot.csproj
+#Prepare
+if(Test-Path .deployment){
+    Remove-Item -Force .deployment
+    Remove-Item -Force CopilotSpeechBot.zip
+ }
+az bot prepare-deploy --lang CSharp --code-dir . --proj-file-path .\SampleBot.csproj
+Compress-Archive * .\CopilotSpeechBot.zip -force
+#Deploy
+az webapp deployment source config-zip --resource-group $ressourceGroup --name $webAppName --src .\CopilotSpeechBot.zip
+
+########################
+#Remove everything
+az group delete --name $CopilotSpeechSample

SpeechRelayBotSample/DeploymentTemplates/SpeechRelayBot.bicep

@@ -0,0 +1,95 @@
+param botName string = 'CopilotSpeechBot'
+param subscriptionId string = ''
+param resourceGroupName string = ''
+@description('Name of the Azure Speech services desployment')
+param speechResourceName string = ''
+param appId string = ''
+param tenantId string = ''
+@description('The resource URI of the cognitive services account')
+param cognitiveServicesResource string = '/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/${speechResourceName}'
+param webAppName string = ''
+
+@description('The Azure Bot FX relay bot')
+resource botResource 'Microsoft.BotService/botServices@2023-09-15-preview' = {
+  name: botName
+  location: 'global'
+  sku: {
+    name: 'F0'
+  }
+  kind: 'azurebot'
+  properties: {
+    displayName: botName
+    iconUrl: 'https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png'
+    endpoint: 'https://${webAppName}.azurewebsites.net/api/messages'
+    msaAppId: appId
+    msaAppTenantId: tenantId
+    msaAppType: 'SingleTenant'
+    luisAppIds: []
+    isStreamingSupported: true
+    schemaTransformationVersion: '1.3'
+    tenantId: tenantId
+    isCmekEnabled: false
+    publicNetworkAccess: 'Enabled'
+    disableLocalAuth: false
+  }
+}
+
+@description('Direct line channel registration')
+resource botDirectLineChannel 'Microsoft.BotService/botServices/channels@2023-09-15-preview' = {
+  parent: botResource
+  name: 'DirectLineChannel'
+  location: 'global'
+  properties: {
+    properties: {
+      sites: [
+        {
+          siteName: 'Default Site'
+          isEnabled: true
+          isV1Enabled: true
+          isV3Enabled: true
+          isSecureSiteEnabled: false
+          isBlockUserUploadEnabled: false
+        }
+      ]
+    }
+    channelName: 'DirectLineChannel'
+    location: 'global'
+  }
+}
+
+@description('Direct Line speech channel')
+resource botDirectLineSpeechChannel 'Microsoft.BotService/botServices/channels@2023-09-15-preview' = {
+  parent: botResource
+  name: 'DirectLineSpeechChannel'
+  location: 'global'
+  properties: {
+    properties: {
+      cognitiveServiceResourceId: cognitiveServicesResource
+      isEnabled: true
+      isDefaultBotForCogSvcAccount: false
+    }
+    channelName: 'DirectLineSpeechChannel'
+    location: 'global'
+  }
+}
+
+@description('Web chat channel for testing')
+resource botWebChatChannel 'Microsoft.BotService/botServices/channels@2023-09-15-preview' = {
+  parent: botResource
+  name: 'WebChatChannel'
+  location: 'global'
+  properties: {
+    properties: {
+      sites: [
+        {
+          siteName: 'Default Site'
+          isEnabled: true
+          isWebchatPreviewEnabled: true
+          isBlockUserUploadEnabled: false
+        }
+      ]
+    }
+    channelName: 'WebChatChannel'
+    location: 'global'
+  }
+}

SpeechRelayBotSample/DeploymentTemplates/SpeechRelayBot.json

@@ -0,0 +1,12 @@
+{
+    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
+    "contentVersion": "1.0.0.0",
+    "parameters": {
+        "botServices_CopilotSpeechBot_name": {
+            "value": null
+        },
+        "accounts_CopilotSpeechBotAIService_externalid": {
+            "value": null
+        }
+    }
+}

SpeechRelayBotSample/README.md

@@ -0,0 +1,198 @@
+# Copilot Studio Speech Bot
+
+Sample of connecting Bot Framework v4 bot to a Copilot Studio bot. The goal of this sample is to have a Speech Enabled Copilot Studio bot published on a DirectLine Speech Channel.
+This sample builds upon the Relay Bot sample found in this repository under [Relay Bot Sample](../RelayBotSample/README.md)
+
+***NOTE:***
+A feature called ***Allowlists*** is upcoming that will eliminate the need for custom implementation and allow Azure Bot Framework to call a Copilot Studion bot as a skill
+This feature is today only available for classic Copilots
+[Use a classic chatbot as a skill](https://learn.microsoft.com/en-us/microsoft-copilot-studio/advanced-use-pva-as-a-skill)
+
+This bot has been created based on [Bot Framework](https://dev.botframework.com), it shows how to create an Azure Bot Service bot that connects to a Copilot Studio bot via Direct Line API
+
+## Prerequisites
+
+- [.NET Core SDK](https://dotnet.microsoft.com/download) version 2.1
+
+  ```bash
+  # determine dotnet version
+  dotnet --version
+  ```
+- [Power Platform CLI](https://learn.microsoft.com/en-us/power-platform/developer/cli/introduction?tabs=windows#install-microsoft-power-platform-cli)
+
+  ```bash
+  # install PAC CLI via dotnet tool
+  dotnet tool install --global Microsoft.PowerApps.CLI.Tool
+  ```
+- [Aure Command Line Interface](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli-windows?tabs=azure-cli#install-or-update)
+
+
+## Setup
+### Setup required resources in Microsoft Azure
+
+The following sets up Azure Cognitive Services for speech as well as an App Service plan, a web app and an Azure Bot. Found in
+[AZ CLI deployment scrapbook](CopilotSpeechBot_ResourceDeployment.azcli)
+
+- Deploy Azure resources
+
+    ```powershell
+    # Assign values to variables
+    $ressourceGroup="CopilotSpeechSample"
+    $location="westeurope"
+    $appServiceName="CopilotSpeechBotAppPlan"
+    $webAppName="CopilotSpeechBotWebApp"
+    $cognitiveServiceAccountName="CopilotSpeechBotAIService"
+    $botName="CopilotSpeechBot"
+    $appRegistrationName="CopilotSpeechBotPrincipal"
+    $tenantId="<tenantID>"
+    $webAppEndoint=echo https://$webAppName.azurewebsites.net/api/messages
+    ##Make sure to use the right subscription
+    $subscriptionId=<ID from az account set output>
+    ##Connect to Azure subscroption
+    az login
+    az account set --subscription $subscriptionId
+
+    ##Create speech services
+    az group create --location westeurope --name $ressourceGroup
+    az cognitiveservices account create -n $cognitiveServiceAccountName -g $ressourceGroup --kind SpeechServices --sku F0 -l $location --yes
+    $cognitiveServicesKey=$(az cognitiveservices account keys list -n $cognitiveServiceAccountName -g $ressourceGroup --query "key1")
+
+    ##Create app plan and web app
+    az appservice plan create -g $ressourceGroup -n $appServiceName --sku F1 --location $location
+    az webapp create -g $ressourceGroup -n $webAppName -p $appServiceName
+
+    #Enable web sockets on the app
+    az webapp config set -g $ressourceGroup -n $webAppName --web-sockets-enabled true
+    #Create entry app registration and bot
+    $appId = $(az ad app create --display-name $appRegistrationName --query "appId")
+    ## Create the Azure BotFX bot
+    az bot create -g $ressourceGroup -n $botName --app-type SingleTenant --appid $appId --tenant-id $tenantId
+    #Set bot endpoint to web app path
+    az bot update -g $ressourceGroup -n $botName --endpoint $webAppEndoint
+    ```
+- Enable DirectLine Speech
+
+  - In [Azure Portal](https://portal.azure.com) go to your bot resource you created ***Settings*** > ***Channels*** > ***Available Channels*** > ***Direct Line Speech***. Select the Cognitive Service resource created earlier and leave the optional fields blank and save.
+  - In your bot resource go to  ***Settings*** > ***Configuration*** and check **Enable Streaming Endpoint**
+
+
+### Compile the bot
+
+- Clone the repository
+
+    ```bash
+    #Clone Echo bot sample
+    git clone https://github.com/microsoft/CopilotStudioSamples.git
+    cd RelayBotSample
+    ```
+
+- In a terminal, navigate to `SpeechRelayBot/`
+- Update the file `appsettings.json` with your Copilot Studio bot id, tenant id, bot name and other settings.
+
+    If you used the deployment from step 1 the MicrosoftAppId is already available in the variable $appId. Alternatively this can be found 
+    in Azure Portal <Your bot resource> navigate to ***Settings*** then ***Configuration*** and copy the Microsoft App ID and Tenant ID.
+    The MicrosoftAppPassword can be found by clicking on ***Manage Password*** and ***Certificates & Secrets***. Create a new secret and copy its value.
+    ```  
+    "MicrosoftAppId": "aaa",
+    "MicrosoftAppPassword": "bbb",
+    "MicrosoftAppTenantId":"ccc",
+    ```
+    To retrieve your Copilot Studio bot's token endpoint, click on left side pane's ***Manage***, click ***Channels*** and click on the Direct Line Speech channel.
+    Copy and save the token endpoint value by clicking Copy.
+
+    To retrieve your tenant ID use the value from above. You can also use the following command in a terminal connected with PAC CLI
+
+    ```bash
+    pac auth who
+    ```
+    To retrieve your Copilot Studio bot ID and name, use the following command in a terminal connected with PAC CLI
+
+    ```bash
+    pac copilot list
+    ```
+
+
+    ```json
+    "BotService": {
+      "BotName": "<Name of your CPS bot>",
+      "BotId": "<Bot ID copied from CLI output>",
+      "TenantId": "<Tenant copied from CLI output>",
+      "TokenEndPoint": "<Token endpoint copied from channel panel>"
+    }
+   ``` 
+   The complete `appsettings.json` file in your root directory should resemble the following: 
+
+   ```bash
+    {
+      "MicrosoftAppType":"SingleTenant",
+      "MicrosoftAppId": "aaa",
+      "MicrosoftAppPassword": "bbb",
+      "MicrosoftAppTenantId":"ccc",
+      "BotService": {
+        "BotName": "<name>",
+        "BotId": "xxx",
+        "TenantId": "yyy",
+        "TokenEndPoint": "zzz"
+      },
+      "ConversationPool": {
+        "TokenRefreshCheckIntervalInMinute": 10,
+        "TokenRefreshIntervalInMinute": 30,
+        "ConversationEndAfterIdleTimeInMinute": 30,
+        "ConversationEndCheckIntervalInMinute": 10
+      }
+    }
+   ```
+
+- Build the bot prepare it and deploy.
+
+  ```bash
+    #Build
+    dotnet build -c release .\SampleBot.csproj
+    #Prepare
+    if(Test-Path .deployment){
+        Remove-Item -Force .deployment
+        Remove-Item -Force CopilotSpeechBot.zip
+    }
+    az bot prepare-deploy --lang CSharp --code-dir . --proj-file-path .\SampleBot.csproj
+    Compress-Archive * .\CopilotSpeechBot.zip -force
+    #Deploy
+    az webapp deployment source config-zip --resource-group $ressourceGroup --name $webAppName --src .\CopilotSpeechBot.zip
+  ```
+
+## Testing the bot using Bot Framework Emulator
+
+[Bot Framework Emulator](https://github.com/microsoft/botframework-emulator) is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.
+
+- Install the Bot Framework Emulator version 4.3.0 or greater from [here](https://github.com/Microsoft/BotFramework-Emulator/releases)
+
+### Connect to the bot using Bot Framework Emulator
+
+- Launch Bot Framework Emulator
+- File -> Open Bot
+- Enter a Bot URL of [http://localhost:3978/api/messages](http://localhost:3978/api/messages)
+
+## Testing the voice channel
+
+[Windows Voice Assistant Client](https://github.com/Azure-Samples/Cognitive-Services-Voice-Assistant/blob/main/clients/csharp-wpf/README.md#windows-voice-assistant-client) is a desktop application that allows testing of Direct Line Speech enabled bot endpoints
+- Install the Voice Assistant Client
+
+### Connect to your bot
+
+- Launch voice assistant client
+- Follow the [instructions on the Voice Assistant page](https://github.com/Azure-Samples/Cognitive-Services-Voice-Assistant/blob/main/clients/csharp-wpf/README.md#windows-voice-assistant-client)  to connect to your speech services resource 
+
+
+## Further reading
+
+- [Bot Framework Documentation](https://docs.botframework.com)
+- [Bot Basics](https://docs.microsoft.com/azure/bot-service/bot-builder-basics?view=azure-bot-service-4.0)
+- [Activity processing](https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-concept-activity-processing?view=azure-bot-service-4.0)
+- [Azure Bot Service Introduction](https://docs.microsoft.com/azure/bot-service/bot-service-overview-introduction?view=azure-bot-service-4.0)
+- [Azure Bot Service Documentation](https://docs.microsoft.com/azure/bot-service/?view=azure-bot-service-4.0)
+- [.NET Core CLI tools](https://docs.microsoft.com/en-us/dotnet/core/tools/?tabs=netcore2x)
+- [Azure CLI](https://docs.microsoft.com/cli/azure/?view=azure-cli-latest)
+- [Azure Portal](https://portal.azure.com)
+- [Language Understanding using LUIS](https://docs.microsoft.com/en-us/azure/cognitive-services/luis/)
+- [Channels and Bot Connector Service](https://docs.microsoft.com/en-us/azure/bot-service/bot-concepts?view=azure-bot-service-4.0)
+- [Restify](https://www.npmjs.com/package/restify)
+- [dotenv](https://www.npmjs.com/package/dotenv)