Skip to content

Added instructions of how to use the AI bot #7969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 28, 2024
Merged

Added instructions of how to use the AI bot #7969

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f4ce3f
Added instructions of how to use the AI bot
raych1 Mar 28, 2024
8529bdd
Use aka link
raych1 Mar 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion tools/sdk-ai-bots/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,22 @@
This folder contains a collection of tools that utilize AI techniques.

#### AzureSdkQaBot
AzureSdkQaBot is a Teams bot which can answer the questions related to the Azure SDK domain. It is written in C#.
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#.

**Capability of this bot**

- This bot can provide general QA by searching through a knowledge base that includes documents from three sources:
- Azure SDK documents available at the [engineering hub site](https://eng.ms/docs/products/azure-developer-experience)
- TypeSpec documents available at https://github.com/azure/typespec-azure
- 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)

- 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)

**How to use this bot**
- Create a post in the teams channel by accessing https://aka.ms/azsdk/teams-bot.
- In the post content, please include `@AzureSDKAssistant-dev` with your questions.
> Note: Select the name when typing `@`, copying of the `@AzureSDKAssistant-dev` text to the question would not work.


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