Skip to content

Commit

Permalink
Teams extension installation (#210)
Browse files Browse the repository at this point in the history
  • Loading branch information
ross-p-smith authored Jan 20, 2024
1 parent a648105 commit f2ced89
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 21 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@ Learn more about deploying the Teams extension [here](./docs/TEAMS_EXTENSION.md)
![One-click Deploy](/media/oneClickDeploy.png)
## One-click deploy
### Pre-requisites
* An [Azure OpenAI resource](https://learn.microsoft.com/azure/ai-services/openai/how-to/create-resource?pivots=web-portal) and a deployment for one of the following Chat model and an embedding model:
- Azure subscription - [Create one for free](https://azure.microsoft.com/free/) with owner access.
- An [Azure OpenAI resource](https://learn.microsoft.com/azure/ai-services/openai/how-to/create-resource?pivots=web-portal) and a deployment for one of the following Chat model and an embedding model:
* Chat Models
* GPT-3.5
* GPT-4
Expand All @@ -105,7 +106,6 @@ Learn more about deploying the Teams extension [here](./docs/TEAMS_EXTENSION.md)

**Note**: The deployment template defaults to **gpt-35-turbo** and **text-embedding-ada-002**. If your deployment names are different, update them in the deployment process.

- Azure subscription - [Create one for free](https://azure.microsoft.com/free/) with contributor access.
- [Visual Studio Code](https://code.visualstudio.com/)
- Extensions
- [Azure Functions](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurefunctions)
Expand Down
9 changes: 4 additions & 5 deletions docs/TEAMS_EXTENSION.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ This extension enables users to experience Chat with your data within Teams, wit
**IMPORTANT**: Before you proceed, installation and configuration of the [Chat with your data with speech-to-text deployment](../README.md) is required.

### Pre-requisites
- Azure subscription - [Create one for free](https://azure.microsoft.com/free/) with contributor access.
- [Visual Studio Code](https://code.visualstudio.com/)
- Extensions
- [Teams Toolkit](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension) (optional: Teams extension only)
Expand All @@ -24,7 +23,7 @@ This extension enables users to experience Chat with your data within Teams, wit
- In order to publish the App to the Teams Store, the Teams Administrator role is required.

### Deploy backend Azure Function
<!-- TODO: Updated prior to PR -->

[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure-Samples%2Fchat-with-your-data-solution-accelerator%2Fmain%2Fextensions%2Finfrastructure%2Fmain.json)

Note: The (p) suffix on the App Setting (below) means that you should use the same resources and services deployed during the [Chat with your data with speech-to-text deployment](../README.md)
Expand All @@ -34,9 +33,9 @@ Note: The (p) suffix on the App Setting (below) means that you should use the sa
|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](#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 AI Search (p) | The **name** of your Azure AI Search resource. e.g. https://<**name**>.search.windows.net. |
|Azure Search Index (p) | The name of your Azure AI Search Index. |
|Azure Search Key (p) | An admin key for your Azure AI 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". |
Expand Down
12 changes: 6 additions & 6 deletions extensions/infrastructure/main.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,16 @@ param HostingPlanSku string = 'B3'
@secure()
param AppInsightsConnectionString string

@description('Azure Cognitive Search Resource - Created during the "Chat with your data" Solution Accelerator')
param AzureCognitiveSearch string
@description('Azure AI Search Resource - Created during the "Chat with your data" Solution Accelerator')
param AzureSearchName string

@description('Azure Cognitive Search Index - Created during the "Chat with your data" Solution Accelerator')
@description('Azure AI Search Index - Created during the "Chat with your data" Solution Accelerator')
param AzureSearchIndex string

@description('Azure Cognitive Search Conversation Log Index - Created during the "Chat with your data" Solution Accelerator')
@description('Azure AI Search Conversation Log Index - Created during the "Chat with your data" Solution Accelerator')
param AzureSearchConversationLogIndex string = 'conversations'

@description('Azure Cognitive Search Key - Created during the "Chat with your data" Solution Accelerator')
@description('Azure AI Search Key - Created during the "Chat with your data" Solution Accelerator')
@secure()
param AzureSearchKey string

Expand Down Expand Up @@ -154,7 +154,7 @@ resource Function 'Microsoft.Web/sites@2018-11-01' = {
{ name: 'FUNCTIONS_EXTENSION_VERSION', value: '~4'}
{ name: 'WEBSITES_ENABLE_APP_SERVICE_STORAGE', value: 'false'}
{ name: 'APPINSIGHTS_CONNECTION_STRING', value: AppInsightsConnectionString}
{ name: 'AZURE_SEARCH_SERVICE', value: 'https://${AzureCognitiveSearch}.search.windows.net'}
{ name: 'AZURE_SEARCH_SERVICE', value: 'https://${AzureSearchName}.search.windows.net'}
{ name: 'AZURE_SEARCH_INDEX', value: AzureSearchIndex}
{ name: 'AZURE_SEARCH_CONVERSATIONS_LOG_INDEX', value: AzureSearchConversationLogIndex}
{ name: 'AZURE_SEARCH_KEY', value: AzureSearchKey}
Expand Down
16 changes: 8 additions & 8 deletions extensions/infrastructure/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.23.1.45101",
"templateHash": "3711349996173669799"
"version": "0.24.24.22086",
"templateHash": "15613566963175325138"
}
},
"parameters": {
Expand Down Expand Up @@ -63,29 +63,29 @@
"description": "Application Insights Connection String - Created during the \"Chat with your data\" Solution Accelerator"
}
},
"AzureCognitiveSearch": {
"AzureSearchName": {
"type": "string",
"metadata": {
"description": "Azure Cognitive Search Resource - Created during the \"Chat with your data\" Solution Accelerator"
"description": "Azure AI Search Resource - Created during the \"Chat with your data\" Solution Accelerator"
}
},
"AzureSearchIndex": {
"type": "string",
"metadata": {
"description": "Azure Cognitive Search Index - Created during the \"Chat with your data\" Solution Accelerator"
"description": "Azure AI Search Index - Created during the \"Chat with your data\" Solution Accelerator"
}
},
"AzureSearchConversationLogIndex": {
"type": "string",
"defaultValue": "conversations",
"metadata": {
"description": "Azure Cognitive Search Conversation Log Index - Created during the \"Chat with your data\" Solution Accelerator"
"description": "Azure AI Search Conversation Log Index - Created during the \"Chat with your data\" Solution Accelerator"
}
},
"AzureSearchKey": {
"type": "securestring",
"metadata": {
"description": "Azure Cognitive Search Key - Created during the \"Chat with your data\" Solution Accelerator"
"description": "Azure AI Search Key - Created during the \"Chat with your data\" Solution Accelerator"
}
},
"AzureSearchSemanticSearchConfig": {
Expand Down Expand Up @@ -308,7 +308,7 @@
},
{
"name": "AZURE_SEARCH_SERVICE",
"value": "[format('https://{0}.search.windows.net', parameters('AzureCognitiveSearch'))]"
"value": "[format('https://{0}.search.windows.net', parameters('AzureSearchName'))]"
},
{
"name": "AZURE_SEARCH_INDEX",
Expand Down

0 comments on commit f2ced89

Please sign in to comment.