Skip to content

Commit

Permalink
Merge branch 'main' into kavin/c#-tools
Browse files Browse the repository at this point in the history
  • Loading branch information
singhk97 authored Oct 1, 2024
2 parents fa05001 + cdd1d49 commit 9c9de98
Show file tree
Hide file tree
Showing 26 changed files with 42 additions and 44 deletions.
2 changes: 1 addition & 1 deletion dotnet/packages/Microsoft.TeamsAI/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ To get started, take a look at the [getting started docs](https://github.com/mic

## Migration

If you're migrating an existing project, switching to add on the Teams AI Library layer is quick and simple. See the [migration guide](https://github.com/microsoft/teams-ai/blob/main/getting-started/MIGRATION/DOTNET.md).
If you're migrating an existing project, switching to add on the Teams AI Library layer is quick and simple. See the [migration guide](https://github.com/microsoft/teams-ai/blob/main/getting-started/MIGRATION/02.DOTNET.md).
4 changes: 2 additions & 2 deletions dotnet/samples/04.ai.a.teamsChefBot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Above steps use Azure OpenAI as AI service, optionally, you can also use OpenAI

**For debugging (F5)**

1. Set your [OpenAI API Key](https://openai.com/api/) to *appsettings.Development.json*.
1. Set your [OpenAI API Key](https://platform.openai.com/settings/profile?tab=api-keys) to *appsettings.Development.json*.

```json
"OpenAI": {
Expand All @@ -72,7 +72,7 @@ Above steps use Azure OpenAI as AI service, optionally, you can also use OpenAI

To configure the Azure resources to have OpenAI environment variables:

1. In `./env/.env.dev.user` file, paste your [OpenAI API Key](https://openai.com/api/) to the environment variable `SECRET_OPENAI_KEY=`.
1. In `./env/.env.dev.user` file, paste your [OpenAI API Key](https://platform.openai.com/settings/profile?tab=api-keys) to the environment variable `SECRET_OPENAI_KEY=`.

## Appendix

Expand Down
4 changes: 2 additions & 2 deletions dotnet/samples/04.ai.b.messageExtensions.gptME/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Above steps use Azure OpenAI as AI service, optionally, you can also use OpenAI

**For Local Debug (F5) with Teams Toolkit for Visual Studio**

1. Set your [OpenAI API Key](https://openai.com/api/) to *appsettings.Development.json*.
1. Set your [OpenAI API Key](https://platform.openai.com/settings/profile?tab=api-keys) to *appsettings.Development.json*.

```json
"OpenAI": {
Expand All @@ -107,7 +107,7 @@ Above steps use Azure OpenAI as AI service, optionally, you can also use OpenAI

To configure the Azure resources to have OpenAI environment variables:

1. In `./env/.env.dev.user` file, paste your [OpenAI API Key](https://openai.com/api/) to the environment variable `SECRET_OPENAI_KEY=`.
1. In `./env/.env.dev.user` file, paste your [OpenAI API Key](https://platform.openai.com/settings/profile?tab=api-keys) to the environment variable `SECRET_OPENAI_KEY=`.

## Further reading

Expand Down
4 changes: 2 additions & 2 deletions dotnet/samples/04.ai.c.actionMapping.lightBot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Above steps use Azure OpenAI as AI service, optionally, you can also use OpenAI

**For Local Debug (F5) with Teams Toolkit for Visual Studio**

1. Set your [OpenAI API Key](https://openai.com/api/) to *appsettings.Development.json*.
1. Set your [OpenAI API Key](https://platform.openai.com/settings/profile?tab=api-keys) to *appsettings.Development.json*.

```json
"OpenAI": {
Expand All @@ -103,7 +103,7 @@ Above steps use Azure OpenAI as AI service, optionally, you can also use OpenAI

To configure the Azure resources to have OpenAI environment variables:

1. In `./env/.env.dev.user` file, paste your [OpenAI API Key](https://openai.com/api/) to the environment variable `SECRET_OPENAI_KEY=`.
1. In `./env/.env.dev.user` file, paste your [OpenAI API Key](https://platform.openai.com/settings/profile?tab=api-keys) to the environment variable `SECRET_OPENAI_KEY=`.

## Further reading

Expand Down
4 changes: 2 additions & 2 deletions dotnet/samples/04.ai.d.chainedActions.listBot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Above steps use Azure OpenAI as AI service, optionally, you can also use OpenAI

**For debugging (F5)**

1. Set your [OpenAI API Key](https://openai.com/api/) to _appsettings.Development.json_.
1. Set your [OpenAI API Key](https://platform.openai.com/settings/profile?tab=api-keys) to _appsettings.Development.json_.

```json
"OpenAI": {
Expand All @@ -152,7 +152,7 @@ Above steps use Azure OpenAI as AI service, optionally, you can also use OpenAI

To configure the Azure resources to have OpenAI environment variables:

1. In `./env/.env.dev.user` file, paste your [OpenAI API Key](https://openai.com/api/) to the environment variable `SECRET_OPENAI_KEY=`.
1. In `./env/.env.dev.user` file, paste your [OpenAI API Key](https://platform.openai.com/settings/profile?tab=api-keys) to the environment variable `SECRET_OPENAI_KEY=`.

## Further reading

Expand Down
4 changes: 2 additions & 2 deletions dotnet/samples/04.ai.e.chainedActions.devOpsBot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Above steps use Azure OpenAI as AI service, optionally, you can also use OpenAI

**For Local Debug (F5) with Teams Toolkit for Visual Studio**

1. Set your [OpenAI API Key](https://openai.com/api/) to *appsettings.Development.json*.
1. Set your [OpenAI API Key](https://platform.openai.com/settings/profile?tab=api-keys) to *appsettings.Development.json*.

```json
"OpenAI": {
Expand All @@ -130,7 +130,7 @@ Above steps use Azure OpenAI as AI service, optionally, you can also use OpenAI

To configure the Azure resources to have OpenAI environment variables:

1. In `./env/.env.dev.user` file, paste your [OpenAI API Key](https://openai.com/api/) to the environment variable `SECRET_OPENAI_KEY=`.
1. In `./env/.env.dev.user` file, paste your [OpenAI API Key](https://platform.openai.com/settings/profile?tab=api-keys) to the environment variable `SECRET_OPENAI_KEY=`.

## Further reading

Expand Down
4 changes: 2 additions & 2 deletions dotnet/samples/04.ai.f.vision.cardMaster/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Above steps use Azure OpenAI as AI service, optionally, you can also use OpenAI

**For Local Debug (F5) with Teams Toolkit for Visual Studio**

1. Set your [OpenAI API Key](https://openai.com/api/) to *appsettings.Development.json*.
1. Set your [OpenAI API Key](https://platform.openai.com/settings/profile?tab=api-keys) to *appsettings.Development.json*.

```json
"OpenAI": {
Expand All @@ -64,7 +64,7 @@ Above steps use Azure OpenAI as AI service, optionally, you can also use OpenAI

To configure the Azure resources to have OpenAI environment variables:

1. In `./env/.env.dev.user` file, paste your [OpenAI API Key](https://openai.com/api/) to the environment variable `SECRET_OPENAI_KEY=`.
1. In `./env/.env.dev.user` file, paste your [OpenAI API Key](https://platform.openai.com/settings/profile?tab=api-keys) to the environment variable `SECRET_OPENAI_KEY=`.

## Further reading

Expand Down
4 changes: 2 additions & 2 deletions dotnet/samples/04.e.twentyQuestions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Above steps use Azure OpenAI as AI service, optionally, you can also use OpenAI

**For Local Debug (F5) with Teams Toolkit for Visual Studio**

1. Set your [OpenAI API Key](https://openai.com/api/) to *appsettings.Development.json*.
1. Set your [OpenAI API Key](https://platform.openai.com/settings/profile?tab=api-keys) to *appsettings.Development.json*.

```json
"OpenAI": {
Expand All @@ -72,7 +72,7 @@ Above steps use Azure OpenAI as AI service, optionally, you can also use OpenAI

To configure the Azure resources to have OpenAI environment variables:

1. In `./env/.env.dev.user` file, paste your [OpenAI API Key](https://openai.com/api/) to the environment variable `SECRET_OPENAI_KEY=`.
1. In `./env/.env.dev.user` file, paste your [OpenAI API Key](https://platform.openai.com/settings/profile?tab=api-keys) to the environment variable `SECRET_OPENAI_KEY=`.

## Further reading

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This sample shows how to integrate your Azure AI Search index as a data source i
The object between the `<context></context>` tags is an entry from the restaurants index.

## Set up instructions
All the samples in the C# .NET SDK can be set up in the same way. You can find the step by step instructions here: [Setup Instructions](../README.md).
All the samples in the C# .NET SDK can be set up in the same way. You can find the step by step instructions here: [Setup Instructions](../AzureAISearchBot/README.md#set-up-instructions).

Note that, this sample requires AI service so you need one more pre-step before Local Debug (F5).

Expand Down
2 changes: 1 addition & 1 deletion getting-started/CONCEPTS/DATA-SOURCES.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Our most complex C# example is the `KernelMemoryDataSource` in the Chef Bot samp
#### Javascript

Here is an example of the configuration for the
[Chef Bot sample](https://github.com/microsoft/teams-ai/tree/main/js/samples/04.ai.a.teamsChefBot):
[Chef Bot sample](https://github.com/microsoft/teams-ai/tree/main/js/samples/04.ai-apps/a.teamsChefBot):

```js
// Inside VectraDataSource.ts
Expand Down
2 changes: 1 addition & 1 deletion getting-started/MIGRATION/01.JS.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ If you have a bot built using the JS BotFramework SDK, the following will help y

## New Project or Migrate existing app

Since the library builds on top of the BF SDK, much of the bot logic can be directly carried over to the Teams AI app. If you want to start with a new project, set up the Echo bot sample in the [quick start](../.QUICKSTART.md) guide and jump directly to [step 2](#2-replace-the-activity-handler-implementations-with-specific-route-handlers).
Since the library builds on top of the BF SDK, much of the bot logic can be directly carried over to the Teams AI app. If you want to start with a new project, set up the Echo bot sample in the [quick start](../QUICKSTART.md) guide and jump directly to [step 2](#2-replace-the-activity-handler-implementations-with-specific-route-handlers).

If you want to migrate your existing app start with [step 1](#1-replace-the-activityhandler-with-the-application-object).

Expand Down
2 changes: 1 addition & 1 deletion getting-started/MIGRATION/02.DOTNET.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ If you have a bot built using the C# BF SDK, the following will help you update

## New Project or Migrate existing app

Since the library builds on top of the BF SDK, much of the bot logic can be directly carried over to the Teams AI app. If you want to start with a new project, set up the Echo bot sample in the [quick start](../.QUICKSTART.md) guide and jump directly to [step 2](#2-replace-the-activity-handler-implementations-with-specific-route-handlers).
Since the library builds on top of the BF SDK, much of the bot logic can be directly carried over to the Teams AI app. If you want to start with a new project, set up the Echo bot sample in the [quick start](../QUICKSTART.md) guide and jump directly to [step 2](#2-replace-the-activity-handler-implementations-with-specific-route-registration-method).

If you want to migrate your existing app start with [step 1](#1-replace-the-activityhandler-with-the-application-object).

Expand Down
2 changes: 1 addition & 1 deletion getting-started/QUICKSTART.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To get started, ensure that you have the following tools:
| [Git](https://git-scm.com/downloads) | Git is a version control system that helps you manage different versions of code within a repository. |
| [Microsoft Teams](https://www.microsoft.com/microsoft-teams/download-app) | Microsoft Teams to collaborate with everyone you work with through apps for chat, meetings, and call-all in one place. |
| [Microsoft&nbsp;Edge](https://www.microsoft.com/edge) (recommended) or [Google Chrome](https://www.google.com/chrome/) | A browser with developer tools. |
| [Microsoft 365 developer account](/microsoftteams/platform/concepts/build-and-test/prepare-your-o365-tenant) | Access to Teams account with the appropriate permissions to install an app and [enable custom Teams apps and turn on custom app uploading](../../../concepts/build-and-test/prepare-your-o365-tenant.md#enable-custom-teams-apps-and-turn-on-custom-app-uploading). |
| [Microsoft 365 developer account](https://developer.microsoft.com/en-us/microsoft-365/dev-program) | Access to Teams account with the appropriate permissions to install an app and [enable custom Teams apps and turn on custom app uploading](https://learn.microsoft.com/en-us/microsoftteams/teams-custom-app-policies-and-settings). |

<br/>

Expand Down
2 changes: 1 addition & 1 deletion js/packages/teams-ai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ To get started, take a look at the [getting started docs](https://github.com/mic

## Migration

If you're migrating an existing project, switching to add on the Teams AI Library layer is quick and simple. See the [migration guide](https://github.com/microsoft/teams-ai/blob/main/getting-started/MIGRATION/JS.md).
If you're migrating an existing project, switching to add on the Teams AI Library layer is quick and simple. See the [migration guide](https://github.com/microsoft/teams-ai/blob/main/getting-started/MIGRATION/01.JS.md).
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ This sample shows how to incorporate Adaptive Cards into a Microsoft Teams appli
The easiest and fastest way to get up and running is with Teams Toolkit as your development guide. To use Teams Toolkit to automate setup and debugging, please [continue below](#using-teams-toolkit-for-visual-studio-code).
Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section.
For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test)
Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](https://github.com/microsoft/teams-ai/blob/main/getting-started/OTHER/BOTFRAMEWORK-EMULATOR.md) section.
For different ways to test a sample see: [Multiple ways to test](https://github.com/microsoft/teams-ai/tree/main/getting-started/OTHER)
### Using Teams Toolkit for Visual Studio Code
Expand Down
4 changes: 2 additions & 2 deletions js/samples/04.ai-apps/a.teamsChefBot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ If you are using Azure OpenAI then follow these steps:

The easiest and fastest way to get up and running is with Teams Toolkit as your development guide. To use Teams Toolkit to automate setup and debugging, please [continue below](#using-teams-toolkit-for-visual-studio-code).

Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section.
For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test)
Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](https://github.com/microsoft/teams-ai/blob/main/getting-started/OTHER/BOTFRAMEWORK-EMULATOR.md) section.
For different ways to test a sample see: [Multiple ways to test](https://github.com/microsoft/teams-ai/tree/main/getting-started/OTHER)

### Using Teams Toolkit for Visual Studio Code

Expand Down
4 changes: 2 additions & 2 deletions js/samples/05.authentication/a.oauth-adaptiveCard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ Once the bot is successfully sideloaded and installed, send any message to it. T

The easiest and fastest way to get up and running is with Teams Toolkit as your development guide. To use Teams Toolkit to automate setup and debugging, please [continue below](#using-teams-toolkit-for-visual-studio-code).

Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section.
For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test)
Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](https://github.com/microsoft/teams-ai/blob/main/getting-started/OTHER/BOTFRAMEWORK-EMULATOR.md) section.
For different ways to test a sample see: [Multiple ways to test](https://github.com/microsoft/teams-ai/tree/main/getting-started/OTHER)

### Using Teams Toolkit for Visual Studio Code

Expand Down
6 changes: 3 additions & 3 deletions js/samples/05.authentication/b.oauth-bot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This sample shows how to incorporate a basic conversational SSO flow into a Microsoft Teams application using [Bot Framework](https://dev.botframework.com) and the Teams AI SDK.

This sample requires creating an OAuth Connection in Azure Bot Service, which provides a token store to store the token after sign-in. You may need to enable SSO for your app. See [Enable SSO for your app](https://learn.microsoft.com/en-us/microsoftteams/platform/bots/how-to/authentication/bot-sso-overview) for more information.
This sample requires creating an OAuth Connection in Azure Bot Service, which provides a token store to store the token after sign-in.

Note that this bot will only work in tenants where the following graph scopes are permitted:

Expand Down Expand Up @@ -66,8 +66,8 @@ You can interact with this bot by sending it a message, which will echo back to

The easiest and fastest way to get up and running is with Teams Toolkit as your development guide. To use Teams Toolkit to automate setup and debugging, please [continue below](#using-teams-toolkit-for-visual-studio-code).

Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section.
For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test)
Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](https://github.com/microsoft/teams-ai/blob/main/getting-started/OTHER/BOTFRAMEWORK-EMULATOR.md) section.
For different ways to test a sample see: [Multiple ways to test](https://github.com/microsoft/teams-ai/tree/main/getting-started/OTHER)

### Using Teams Toolkit for Visual Studio Code

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ Note that this bot will only work in tenants where the following graph scopes ar
The easiest and fastest way to get up and running is with Teams Toolkit as your development guide. To use Teams Toolkit to automate setup and debugging, please [continue below](#using-teams-toolkit-for-visual-studio-code).
Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section.
For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test)
Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](https://github.com/microsoft/teams-ai/blob/main/getting-started/OTHER/BOTFRAMEWORK-EMULATOR.md) section.
For different ways to test a sample see: [Multiple ways to test](https://github.com/microsoft/teams-ai/tree/main/getting-started/OTHER)
### Using Teams Toolkit for Visual Studio Code
Expand Down
4 changes: 2 additions & 2 deletions js/samples/05.authentication/d.teamsSSO-bot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ This sample depends on Teams SSO and gives you more flexibility on how to config
The easiest and fastest way to get up and running is with Teams Toolkit as your development guide. To use Teams Toolkit to automate setup and debugging, please [continue below](#using-teams-toolkit-for-visual-studio-code).
Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section.
For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test)
Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](https://github.com/microsoft/teams-ai/blob/main/getting-started/OTHER/BOTFRAMEWORK-EMULATOR.md) section.
For different ways to test a sample see: [Multiple ways to test](https://github.com/microsoft/teams-ai/tree/main/getting-started/OTHER)
### Using Teams Toolkit for Visual Studio Code
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ This sample depends on Teams SSO and gives you more flexibility on how to config

The easiest and fastest way to get up and running is with Teams Toolkit as your development guide. To use Teams Toolkit to automate setup and debugging, please [continue below](#using-teams-toolkit-for-visual-studio-code).

Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](../README.md#testing-in-botframework-emulator) section.
For different ways to test a sample see: [Multiple ways to test](../README.md#multiple-ways-to-test)
Otherwise, if you only want to run the bot locally and build manually, please jump to the [BotFramework Emulator](https://github.com/microsoft/teams-ai/blob/main/getting-started/OTHER/BOTFRAMEWORK-EMULATOR.md) section.
For different ways to test a sample see: [Multiple ways to test](https://github.com/microsoft/teams-ai/tree/main/getting-started/OTHER)

### Using Teams Toolkit for Visual Studio Code

Expand Down
Loading

0 comments on commit 9c9de98

Please sign in to comment.