Skip to content

Commit

Permalink
updated README with general instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
lilyydu committed Aug 30, 2024
1 parent 664b89c commit b4ec84f
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion js/samples/04.ai-apps/a.teamsChefBot/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Microsoft Teams Conversational Bot with AI: Teams Chef

This is a conversational bot for Microsoft Teams that thinks it's a Chef to help you cook apps using the Teams AI Library. The bot uses the `gpt-3.5-turbo` model to chat with Teams users and respond in a polite and respectful manner, staying within the scope of the conversation.
This is a conversational streaming bot for Microsoft Teams that thinks it's a Chef to help you cook apps using the Teams AI Library. The bot uses the `gpt-4o` model to chat with Teams users and respond in a polite and respectful manner, staying within the scope of the conversation.

<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->

Expand All @@ -21,6 +21,8 @@ This sample illustrates how to use [Retrieval Augmented Generation (RAG)](https:

The sample uses a local Vector Database, called [Vectra](https://github.com/Stevenic/vectra), and [Semantic Search](https://en.wikipedia.org/wiki/Semantic_search) to find the most relevant information to include in the prompt for the users input. The index can be found in `./index/teams-ai` and includes all of the projects Getting Started docs and the source code for the Teams AI Library. This means you can ask the Teams Chef Bot anything about the library and it can answer it. You can even ask it to write sample code for you!

In addition, the sample illustrates our streaming feature. This is enabled via using our `DefaultAugmentation` class, and by setting `stream: true` in the OpenAIModel declaration. The informative message can be set in the `ActionPlanner` declaration via the `startStreamingMessage` config. Custom logic is available through the `StreamingResponse` class.

![Teams Chef Bot](./assets/TeamsChef003.png?raw=1)

## Setting up the sample
Expand Down

0 comments on commit b4ec84f

Please sign in to comment.