Skip to content

Commit

Permalink
Merge branch 'main' into dotnet-1.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
singhk97 committed Jan 11, 2024
2 parents dc0c99b + c5ec118 commit 6e51ff9
Show file tree
Hide file tree
Showing 28 changed files with 454 additions and 157 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
Welcome to the Teams AI Library! This SDK is specifically designed to assist you in creating bots capable of interacting with Teams and Microsoft 365 applications. It is constructed using the [Bot Framework SDK](https://github.com/microsoft/botbuilder-js) as its foundation, simplifying the process of developing bots that interact with Teams' artificial intelligence capabilities.

![Teams AI flow diagram](https://github.com/microsoft/teams-ai/assets/14900841/154353ff-bafe-4423-abcd-6dc5a8680fe9)
This is a diagram of the Teams-AI flow. Teams AI SDK hooks into the Teams SDK and Azure OpenAI SDK to provide a seamless experience for developers.
This is a diagram of the Teams-AI flow. Teams AI Library SDK hooks into the Teams SDK and Azure OpenAI SDK to provide a seamless experience for developers.

The SDK is currently available for JavaScript/TypeScript applications in the [`js`](./js) folder and via the [teams-ai package on NPM](https://www.npmjs.com/package/@microsoft/teams-ai). .NET support is available in the [`dotnet`](./dotnet) folder and via the [teams-ai package on NuGet](https://www.nuget.org/packages/Microsoft.Teams.AI).

Expand Down
6 changes: 3 additions & 3 deletions getting-started/QUICKSTART.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ _**Navigation**_
- [02.SAMPLES](./SAMPLES.md)
___

In this quickstart we will show you how to get the Echo bot up and running.
In this quickstart we will show you how to get the Echo Bot up and running. The Echo Bot echoes back messages sent to it while keeping track of the number of messages sent by the user.


* [C# Quickstart](#c-quickstart)
Expand All @@ -15,7 +15,7 @@ In this quickstart we will show you how to get the Echo bot up and running.

## C# Quickstart

This guide will show you have the set up the Echo bot using the C# library.
This guide will show you have the set up the Echo Bot using the C# library.

### Prerequisites

Expand Down Expand Up @@ -73,7 +73,7 @@ To get started, ensure that you have the following tools:

## Javascript

This guide will show you have the set up the Echo bot using the JS library.
This guide will show you have the set up the Echo Bot using the JS library.

### Prerequisite

Expand Down
14 changes: 11 additions & 3 deletions getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,21 @@ _**Navigation**_
- [02.SAMPLES](./SAMPLES.md)
___

Get started with the Teams AI Library.
### Get started with the Teams AI Library

The first step is to get a basic bot running E2E through the [Quickstart](./QUICKSTART.md) guide. After that see all the [samples](./SAMPLES.md) available.
The first step is to get a basic bot running E2E through the [Quickstart](./QUICKSTART.md) guide to build Echo Bot, which echoes back any message sent to it. This simple bot helps to familiarize yourself with the Teams AI Library and ensures your system is set up correctly to move onto the AI powered samples.

If you would rather dive into an AI sample first, check out the fully conversational Teams Chef Bot sample on the [samples](./SAMPLES.md) page.

There are numerous samples to try showcasing the different capabilities of the Teams AI Library.

### Migration

If you have a bot built using the BotFramework SDK and want to migrate to the Teams AI library, see [Migration](./MIGRATION/README.md).

To dive deeper into the library, see [Concepts](./CONCEPTS/README.md).
### Concepts

To dive deeper into the library learning more about its AI components and concepts, see [Concepts](./CONCEPTS/README.md).

### Useful links

Expand Down
2 changes: 2 additions & 0 deletions getting-started/SAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Samples are E2E teams apps that are easy to set up locally. There are various sa

The following is a list of all the samples we support organized into four categories. If you are new to the library it is recommended to start with the basic samples.

When you are ready to dive into the AI Samples, try the fully conversational Teams Chef Bot sample that illustrates how to use Retrieval Augmentation Generation to ground the AI model’s answers in custom documents and datasets.

- [Samples](#samples)
- [Basic Samples](#basic-samples)
- [AI Samples](#ai-samples)
Expand Down
8 changes: 7 additions & 1 deletion js/.eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,13 @@
"no-undef": "off", // Disabled due to conflicts with @typescript/eslint
"no-unused-vars": "off", // Disabled due to conflicts with @typescript/eslint
"prettier/prettier": "error",
"jsdoc/empty-tags": "off"
"jsdoc/empty-tags": "off",
"jsdoc/check-tag-names": [
1,
{
"definedTags": ["remarks"] // Allow @remarks
}
]
},
"overrides": [
{
Expand Down
Loading

0 comments on commit 6e51ff9

Please sign in to comment.