Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
t-mbindra authored Jul 30, 2024
1 parent b89442c commit cfd2dba
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions samples/msteams-FAQPlus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,19 @@ This sample implements a chatbot that answers queries based on a custom database
2. Add all your files to the ```src/data``` folder and URLs to ```src/indexer/URL.txt``` and run ```python ./src/indexer/setup.py```.
3. To delete the exisiting index, run ```python .src/indexer/delete.py```.

### How the knowledge base works
![FAQBot Setup](images/architecture.png)
1. **User Query**:
- The user asks the bot a question.
2. **Prompt Generation**:
- The bot generates a prompt based on the user's question.
3. **Azure AI Search**:
- The prompt is sent as a query to Azure AI Search to find relevant information.
- The top ranked search results are sent to the LLM.
4. **Azure OpenAI**:
- The promt is also sent to Azure OpenAI model to set the context and intent.
- The model provides a generative response which is sent back to the user.

## Populate the environment files
1. You need to populate the environment variables in ```env/.env.local.user``` if you are using the ```Debug``` or ```F5``` flow. Else, populate the environment variables in ```env/.env.dev.user``` if you are dpleoying the app on Azure.
2. Go to the the [Azure portal](https://ms.portal.azure.com/) and navigate to the resource group ```FaqBot```.
Expand Down Expand Up @@ -110,19 +123,6 @@ This sample implements a chatbot that answers queries based on a custom database
8. User clears the chat history.
![clear-conversation-history](images/clear.png)

## How the knowledge base works
![FAQBot Setup](images/architecture.png)
1. **User Query**:
- The user asks the bot a question.
2. **Prompt Generation**:
- The bot generates a prompt based on the user's question.
3. **Azure AI Search**:
- The prompt is sent as a query to Azure AI Search to find relevant information.
- The top ranked search results are sent to the LLM.
4. **Azure OpenAI**:
- The promt is also sent to Azure OpenAI model to set the context and intent.
- The model provides a generative response which is sent back to the user.

## Deploy/Host the app on Azure
Instead of the ```Debug``` or ```F5``` flow, you can deploy the app on Azure:
1. [Populate the environment files](#populate-the-environment-files).
Expand All @@ -132,4 +132,4 @@ Instead of the ```Debug``` or ```F5``` flow, you can deploy the app on Azure:
>[!Note]
> Check the status of your dev(hosted on Azure) bots on [Azure Portal](https://portal.azure.com/#home) by navigating to the relevant resource group.
> Check the status of all your Teams apps on [Teams Developer Portal](https://dev.teams.microsoft.com/apps).
> Teams toolkit will also generate an app registration along with a password which can be seen under **App Registrations** on the Azure portal.
> Teams toolkit will also generate an app registration along with a password which can be seen under **App Registrations** on the Azure portal.

0 comments on commit cfd2dba

Please sign in to comment.