Skip to content

Commit 8b22f9d

Browse files
authored
Added instructions of how to use the AI bot (#7969)
* Added instructions of how to use the AI bot * Use aka link
1 parent 115b3f0 commit 8b22f9d

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

tools/sdk-ai-bots/README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,22 @@
22
This folder contains a collection of tools that utilize AI techniques.
33

44
#### AzureSdkQaBot
5-
AzureSdkQaBot is a Teams bot which can answer the questions related to the Azure SDK domain. It is written in C#.
5+
AzureSdkQaBot is a Teams bot which can answer the questions related to the Azure SDK domain. It is powered by Azure OpenAI and written in C#.
6+
7+
**Capability of this bot**
8+
9+
- This bot can provide general QA by searching through a knowledge base that includes documents from three sources:
10+
- Azure SDK documents available at the [engineering hub site](https://eng.ms/docs/products/azure-developer-experience)
11+
- TypeSpec documents available at https://github.com/azure/typespec-azure
12+
- Some markdown documents from a [customized list](https://github.com/Azure/azure-sdk-tools/blob/main/tools/sdk-ai-bots/Embeddings/settings/metadata_customized_docs.json)
13+
14+
- Assist with reviewing pull requests for REST API specifications, including query the status of the specification pull request, providing suggestions for next steps, and facilitating the merge process (note that merging is disabled during testing phase)
15+
16+
**How to use this bot**
17+
- Create a post in the teams channel by accessing https://aka.ms/azsdk/teams-bot.
18+
- In the post content, please include `@AzureSDKAssistant-dev` with your questions.
19+
> Note: Select the name when typing `@`, copying of the `@AzureSDKAssistant-dev` text to the question would not work.
20+
621

722
#### Embeddings
823
It is a tool written in Python that uses `langchain` library to create embeddings in Azure Search Service.

0 commit comments

Comments
 (0)