Skip to content

Latest commit

 

History

History

nodejs

README.md

page_type description products languages extensions urlFragment
sample
This sample app can be use to streaming scenarios in Teams using Azure Open AI and Bot Framework v4 for personal scope.
office-teams
nodejs
contentType createdDate
samples
11/18/2024
officedev-microsoft-teams-samples-bot-streaming-nodejs

Teams Streaming Bot Sample

This bot has been created using Bot Framework and Azure Open AI as a secondary/alternative option to using Teams AI SDK.

Its main purpose is to demonstrate how to build a bot connected to an LLM and send messages through Teams.

Included Features

  • Bots
  • Azure Open AI
  • Streaming

Important

This bot doesn't save any context calls. Therefore, each interaction is individual and unique.

Interaction with bot

StreamingBot

Prerequisites

Run the app (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.

  1. Ensure you have downloaded and installed Visual Studio Code
  2. Install the Teams Toolkit extension
  3. Select File > Open Folder in VS Code and choose this samples directory from the repo
  4. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
  5. Select Debug > Start Debugging or F5 to run the app in a Teams web client.
  6. 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.

Create an Azure Open AI service

  • In Azure portal, create an Azure Open AI service.
  • Deploy Azure Open AI model: Deploy the gpt-35-turbo model in your created Azure Open AI service for the application to perform translation.
  • Collect AzureOpenAIEndpoint, AzureOpenAIKey, AzureOpenAIDeployment values and save these values to update in .env file later.

Setup

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call into the bot.

  1. Run ngrok - point to port 3978

    ngrok http 3978 --host-header="localhost:3978"

    Alternatively, you can also use the dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:

    devtunnel host -p 3978 --allow-anonymous

  2. Setup for Bot

    In Azure portal, create a Azure Bot resource.

    • For bot handle, make up a name.
    • Select "Use existing app registration" (Create the app registration in Microsoft Entra ID beforehand.)
    • If you don't have an Azure account create an Azure free account here

    In the new Azure Bot resource in the Portal,

    • Ensure that you've enabled the Teams Channel
    • In Settings/Configuration/Messaging endpoint, enter the current https URL you were given by running the tunneling application. Append with the path /api/messages

  3. Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

  4. In a terminal, navigate to samples/bot-streaming/nodejs

  5. Install modules

    npm install

  6. Update the .env configuration for the bot to use the Microsoft App Id and App Password from the Bot Framework registration. (Note the App Password is referred to as the "client secret" in the azure portal and you can always create a new client secret anytime.) MicrosoftAppTenantId will be the id for the tenant where application is registered.

  • Also, set MicrosoftAppType in the .env. (Allowed values are: MultiTenant(default), SingleTenant, UserAssignedMSI)

  1. Run your bot at the command line:

    npm start

  2. This step is specific to Teams.

    • Zip up the contents of the appPackage folder to create a manifest.zip (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
    • Upload the manifest.zip to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)
    • Add the app to personal scope (Supported scopes)

Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.

Running the sample

Install App in Teams: InstallApp

Welcome Streaming Card Displayed in Teams: 2.WelcomeStreaming

User Asking a Question to the Bot: 3.AskQuestion

Streaming Results from the Bot in Teams: 4.AskQuestion1

Getting the information: 4.GettingInformation

Bot's Response to the User's Question: 5.AskQuestionResults

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Further reading