Skip to content

Latest commit

 

History

History
98 lines (91 loc) · 6.81 KB

TEAMS_EXTENSION.md

File metadata and controls

98 lines (91 loc) · 6.81 KB

Back to Chat with your data README

Teams extension

USER STORY | ONE-CLICK DEPLOY | SUPPORTING DOCUMENTATION

User Story

User story

This extension brings the Chat with your data experience into Teams, allowing users can stay within their existing workflow and get the answers they need without switching platforms. Rather than building the Chat with your data solution accelerator within Teams from scratch, the same underlying backend used for the web application is leveraged within Teams.

One-click Deploy

One-click deploy

IMPORTANT: Before you proceed, installation and configuration of the Chat with your data with speech-to-text deployment is required.

Deploy Backend Azure Function

Deploy to Azure

App Setting Note
Resource group The resource group that will contain the resources for this accelerator. You can select Create new to create a new group or use the existing resource group created with Speech-to-text deployment.
Resource prefix A text string that will be appended to each resource that gets created, and used as the website name for the web app. This name cannot contain spaces or special characters.
App Insights Connection String (p) The Application Insights connection string to store the application logs.
Azure Cognitive Search (p) The name of your Azure Cognitive Search resource. e.g. https://<name>.search.windows.net.
Azure Search Index (p) The name of your Azure Cognitive Search Index.
Azure Search Key (p) An admin key for your Azure Cognitive Search resource.
Azure OpenAI resource (p) The name of your Azure OpenAI resource. This resource must have already been created previously.
Azure OpenAI key (p) The access key is associated with your Azure OpenAI resource.
Orchestration strategy (p) Use Azure OpenAI Functions (openai_functions) or LangChain (langchain) for messages orchestration. If you are using a new model version 0613 select "openai_functions" (or "langchain"), if you are using a model version 0314 select "langchain".
Azure Form Recognizer Endpoint (p) The name of the Azure Form Recognizer for extracting the text from the documents.
Azure Form Recognizer Key (p) The key of the Azure Form Recognizer for extracting the text from the documents.
Azure Blob Account Name (p) The name of the Azure Blob Storage for storing the original documents to be processed.
Azure Blob Account Key (p) The key of the Azure Blob Storage for storing the original documents to be processed.
Azure Blob Container Name (p) The name of the Container in the Azure Blob Storage for storing the original documents to be processed.

You can find the ARM template used, along with a Bicep file for deploying this accelerator in the /infrastructure directory.

Deploy Teams App

  1. Clone this GitHub repo.
  2. Open the “extensions/teams” folder with Visual Studio Code Teams
  3. Open the file env.env.test ENV
  4. Locate the environment variable AZURE_FUNCTION_URL.
  5. Replace the with the name of your Function App resource (created in previous section)
  6. Save the file.
  7. Select Teams Toolkit from the navigation panel. Teams Toolkit in VS Code
  8. Within the Teams Toolkit panel, login to the following accounts: Sign in to Microsoft 365: Use your Microsoft 365 work or school account with a valid E5 subscription for building your app. If you don't have a valid account, you can join Microsoft 365 developer program to get a free account before you start. Sign in to Azure: Use your Azure account for deploying your app on Azure. You can create a free Azure account before you start. Teams Toolkit Accounts
  9. Under Environment, select test. Teams Toolkit Environment
  10. Under Lifecycle, select Provision. Teams Toolkit Lifecycle Provision
  11. Within the command palette, select test for the environment. Select an Environment
  12. Select the resource group created earlier in the installation Select a Resource Group
  13. When prompted about Azure charges, select Provision. Azure Charges Prompt
  14. Verify that the provisioning was successful. Provision Successful
  15. Under Lifecycle, select Deploy. Teams Toolkit Lifecycle Deploy
  16. Within the command palette, select test for the environment. Select an Environment
  17. When prompted, select Deploy. VS Code Prompt to Deploy
  18. Verify that the Deployment was successful. Deployment successful
  19. Under Lifecycle, select Publish. Teams Toolkit Lifecycle Publish
  20. Within the command palette, select test for the environment. Select an Environment
  21. Verify that the Publish was successful. Publishing successful
  22. Select Go to admin portal. Go to Admin Portal
  23. On the Manage apps page within the Teams Admin portal, you should see one submitted custom app pending approval. Pending Approval
  24. In the search by name input box, enter: enterprise chat Filtered app
  25. Select the app and then select Allow. Selected app
  26. Select the app name. Select app name
  27. Select Publish. Publish app
  28. When prompted, select Publish. Prompt to publish
  29. Depending on your environment, it may take several hours to publish. Teams Publish Success

Supporting documentation

Supporting documentation

Resource links for Teams extension

This solution accelerator deploys the following resources. It's crucial to comprehend the functionality of each. Below are the links to their respective documentation: