Giters

shafaypro / amazon-q-teams-gateway

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Microsoft Teams gateway for Amazon Q Business

⚡ If you created a new Amazon Q Business application on or after April 30th, 2024, you can now set up a Microsoft Teams gateway using the updated instructions provided below. These new Amazon Q Business applications are integrated with IAM Identity Center. The CloudFormation (CFN) template and the necessary steps have been updated to accommodate the setup of the Teams gateway for new applications.

Note: The instructions provided in this guide are specific to Okta, but they should also work for other OIDC 2.0 compliant Identity Providers (IdPs) with minor adjustments.

Amazon Q is a new generative AI-powered application that helps users get work done. Amazon Q can become your tailored business expert and let you discover content, brainstorm ideas, or create summaries using your company’s data safely and securely. For more information see: Introducing Amazon Q, a new generative AI-powered assistant (preview)

In this repo we share a project which lets you use Amazon Q business expert's generative AI to enable Microsoft Teams members to access your organizations data and knowledge sources via conversational question-answering.

You can connect to your organization data via data source connectors and integrate it with Teams Gateway for Amazon Q business expert to enable access to your Teams channel members. It allows your users to:

  • Converse with Amazon Q business expert using Teams Direct Message (DM) to ask questions and get answers based on company data, get help creating new content such as emails, and performing tasks.
  • You can also invite it to participate in your team channels.
    • In a channel users can ask it questions in a new message, or tag it in a thread at any point. Get it to provide additional data points, resolve a debate, or summarize the conversation and capture next steps.

It's amazingly powerful. Here's a demo - seeing is believing!

AmazonQTeamsGatewayDemo3.mp4

It's easy to deploy in your own AWS Account, and add to your own teams. We show you how below.

Note: For an illustrated guide on setting up the integration using Microsoft Entra ID, check this walkthrough.

Features

  • In DMs it responds to all messages
  • Renders answers containing markdown - e.g. headings, lists, bold, italics, tables, etc.
  • In channels it responds only to @mentions, and always replies in thread.
  • Provides thumbs up / down buttons to track user sentiment and help improve performance over time.
  • Provides Source Attribution - see references to sources used by Amazon Q.
  • Aware of conversation context - it tracks the conversation and applies context.
  • Aware of multiple users - when it's tagged in a thread, it knows who said what, and when - so it can contribute in context and accurately summarize the thread when asked.
  • Process up to 5 attached files for document question answering, summaries, etc.
  • Reset and start new conversation in DM channel by using /new_conversation.

This sample Amazon Q business expert Teams application is provided as open source — use it as a starting point for your own solution, and help us make it better by contributing back fixes and features via GitHub pull requests. Explore the code, choose Watch to be notified of new releases, and check back for the latest updates.

Teams Demo

Follow the instructions below to deploy the project to your own AWS account and Teams, and start experimenting!

Deploy the solution

Prerequisites

  1. You need to have an AWS account and an IAM Role/User with permissions to create and manage the necessary resources and components for this application. (If you do not have an AWS account, please see How do I create and activate a new Amazon Web Services account?)

  2. You need to have an Okta Workforce Identity Cloud account. If you haven't signed up yet, see Signing up for Okta

  3. You need to configure SAML and SCIM with Okta and IAM Identity Center. If you haven't configured, see Configuring SAML and SCIM with Okta and IAM Identity Center

  4. You also need to have an existing, working Amazon Q business application integrated with IdC. If you haven't set one up yet, see Creating an Amazon Q application

  5. You need to have users subscribed to your Amazon Q business application, and are able to access Amazon Q Web Experience. If you haven't set one up yet, see Subscribing users to an Amazon Q application

  6. You have aws cli latest version installed on your Linux or MacOS system. If you haven't installed yet, see Installing the AWS CLI version 2

  7. Lastly, you need a Microsoft account and a Microsoft Teams subscription to create and publish the app using the steps below. If you don’t have these, see if your company can create sandboxes for you to experiment, or create a new account and trial subscription as needed to complete the directions below. You will need a Office 365 business subscription for Teams admin privileges. This subscription will also provide a business Microsoft account which will be needed since some steps cannot use an account with a personal email address.

1. Setup

1.1 Create an OIDC app integration, for the gateway, in Okta.

Create the client as a 'Web app'. You will want to enable the 'Refresh Token' grant type, 'Allow everyone in your organization to access', and 'Federation Broker Mode'. Use a placeholder URL, like https://example.com, for the redirect URI, as you will update this later (in step 3).

1.2 Create Trusted token issuer in IAM Identity Center

Create trusted token issuer to trust tokens from OIDC issuer URL using these instructions listed here - https://docs.aws.amazon.com/singlesignon/latest/userguide/using-apps-with-trusted-token-issuer.html. Or you can run the below script.

For the script, you need to have the OIDC issuer URL and the AWS region in which you have your Q business application. To retrieve the OIDC issuer URL, go to Okta account console, click the left hamburger menu and open Security > API and copy the whole 'Issuer URI'.

The script will output trusted token issuer ARN (TTI_ARN) which you will use in the next step.

 export AWS_DEFAULT_REGION=<>
 OIDC_ISSUER_URL=<>
 bin/create-trusted-token-issuer.sh $OIDC_ISSUER_URL

1.3 Create Customer managed application in IAM Identity Center

Create customer managed IdC application by running below script.

For the script, you need to have the OIDC client ID, trusted token issuer ARN, and the region in which you have your Q business application. To retrieve the OIDC client ID, go to Okta account console, click the left hamburger menu and open Applications > Applications and click on the application you created in step 1.1. Copy the 'Client ID'. For TTI_ARN, you can use the output from the previous step.

The script will output the gateway IdC application ARN (GATEWAY_IDC_ARN) which you will use in the next step.

 export AWS_DEFAULT_REGION=<>
 OIDC_CLIENT_ID=<>
 TTI_ARN=<>
 bin/create-idc-application.sh $OIDC_CLIENT_ID $TTI_ARN

2. Register a new app in the Microsoft Azure portal

  1. Go to the Azure Portal: https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade and login with your Microsoft account.
  2. Choose + New registration
    1. For Name, provide the name for your app, e.g. AMAZON-Q-TEAMS-GATEWAY.
    2. For Who can use this application or access this API?, choose Accounts in this organizational directory only (AWS only - Single tenant)
    3. Choose Register
    4. Note down the Application (client) ID value, and the Directory (tenant) ID from the Overview page. You'll need them later when asked for MicrosoftAppId and MicrosoftAppTenantId.
  3. In the API permissions page (on the left navigation menu)
    1. Choose Add a permission
    2. Choose Microsoft Graph
    3. Choose Application permissions
    4. Select User.Read.All
    5. Select ChannelMessage.Read.All
    6. Select Team.ReadBasic.All
    7. Select Files.Read.All
    8. Choose Add permissions. This permission allows the app to read data in your organization's directory about the signed in user.
    9. Remove the original User.Read - Delegated permission (use the … menu on the right to choose Remove permission)
    10. Choose ✓ Grant admin consent for Default Directory
  4. In the Certificates & secrets page
    1. Choose + New client secret
    2. For Description, provide a value such as <Appname>-client-secret
    3. Choose a value for Expires. NOTE: In production, you'll need to manually rotate your secret before it expires.
    4. Choose Add
    5. Note down the Value (not Secret ID) for your new secret. You'll need it later when asked for MicrosoftAppPassword.
  5. (Optional) Choose Owners to add any additional owners for the application.

3. Deploy the stack

We've made this easy by providing pre-built AWS CloudFormation templates that deploy everything you need in your AWS account.

If you are a developer, and you want to build, deploy and/or publish the solution from code, we've made that easy too! See Developer README

  1. Log into the AWS console if you are not already.
  2. Choose one of the Launch Stack buttons below for your desired AWS region to open the AWS CloudFormation console and create a new stack.
  3. Enter the following parameters:
    1. Stack Name: Name your App, e.g. AMAZON-Q-TEAMS-GATEWAY.
    2. AmazonQAppId: Your existing Amazon Q business expert application ID (copy from Amazon Q console).
    3. AmazonQRegion: Choose the region where you created your Amazon Q business expert application.
    4. OIDCIdPName: The name of the OIDC external identity provider ('Okta' and 'Cognito' are explicitly supported, leave empty to use default for others)
    5. OIDCClientId: The client ID of OIDC client you created in step 1.1.
    6. OIDCIssuerURL: The issuer URL of the OIDC client you created in step 1.1.
    7. GatewayIdCAppARN: The application arn of IdC customer managed application you created in step 1.3.
    8. MicrosoftAppId: The MicrosoftAppId you copied in step 2.
    9. ContextDaysToLive: Just leave this as the default (90 days)
Region Easy Deploy Button Template URL - use to upgrade existing stack to a new release
N. Virginia (us-east-1) Launch Stack https://s3.us-east-1.amazonaws.com/aws-ml-blog-us-east-1/artifacts/amazon-q-teams-gateway/AmazonQTeamsGateway.json
Oregon (us-west-2) Launch Stack https://s3.us-west-2.amazonaws.com/aws-ml-blog-us-west-2/artifacts/amazon-q-teams-gateway/AmazonQTeamsGateway.json

When your CloudFormation stack status is CREATE_COMPLETE, choose the Outputs tab, and keep it open - you'll need it below.

4. Update OIDC Client Redirect URL.

Go the app client settings created in IdP (in step 1.1), and update the client signin redirect URL with exported value in Cloudformation stack for the output with suffix OIDCCallbackEndpointExportedName.

5. Register your new app in the Microsoft Bot Framework

  1. Go to the Microsoft Bot Framework: https://dev.botframework.com/bots/new - login with your Microsoft account.
  2. (Optional) Create and upload a cool custom icon for your new Amazon Q Bot. Or, use this one that I created using Amazon Bedrock image playground!
  3. Enter your prefered Display name, Bot handle, and Long description.
  4. For Messaging endpoint copy and paste the value suffixed with TeamsEventHandlerApiEndpoint from your Stack outputs tab (from Step 1). Do not check Enable Streaming Endpoint.
  5. For App type, choose Single Tenant.
  6. For Paste your app ID below to continue, enter the MicrosoftAppId value you noted above.
  7. For App Tenant ID, enter the MicrosoftAppTenantId value you noted above.
  8. Leave the other values as they are, agree to the terms, and choose Register.
  9. On the Channels page, under Add a featured channel choose Microsoft Teams
  10. Choose Microsoft Teams Commercial (most common), and then Save.
  11. Agree to the Terms of Service and choose Agree

6. Configure your Secrets in AWS

6.1 Configure your Teams secrets in order to (1) verify the signature of each request, (2) post on behalf of your bot

IMPORTANT In this example we are not enabling app secret rotation. Enable it for a production app by implementing rotation via AWS Secrets Manager. Please create an issue (or, better yet, a pull request!) in this repo if you want this feature added to a future version.

  1. Login to your AWS console
  2. In your AWS account go to Secret manager, using the URL shown in the stack output suffixed with TeamsSecretConsoleUrl.
  3. Choose Retrieve secret value
  4. Choose Edit
  5. Replace the value of MicrosoftAppId, MicrosoftAppPassword, and MicrosoftAppTenantId with the values you noted in the previous steps.
  6. Choose Save

6.2 Configure OIDC Client Secret in order to exchange the code for token

  1. Login to your AWS console
  2. In your AWS account go to Secret manager, using the URL shown in the stack output suffixed with OIDCClientSecretConsoleUrl.
  3. Choose Retrieve secret value
  4. Choose Edit
  5. Replace the value of OidcClientSecret, you will find those values in the IdP app client configuration.

7. Finally, deploy into Microsoft Teams

  1. Go to Developer Portal for Teams: https://dev.teams.microsoft.com/home - login with your Microsoft Teams user account.
  2. Choose Apps (left side pane) and then + New app
    1. For Name, enter your bot name.
    2. Enter Full name and both short and full Descriptions (you can just use the bot name for them all if you want - just don't leave them empty)
    3. Enter values for Developer information and App URLs fields.
      1. For testing, you can make up values, and URLs like https://www.anycompany.com/ etc. Use real ones for production.
    4. For Application (client) ID* enter the value of MicrosoftAppId from above.
    5. Choose Save.
  3. Under Branding you can upload my AI generated icons, or different icon(s), or none at all.. it's up to you.
  4. Under App features, choose Bot
    1. Select Enter a bot ID, and enter the MicrosoftAppId from the earlier steps
    2. Under What can your bot do?, check Upload and download files.
    3. Under Select the scopes in which people can use this command, check all 3 boxes (Personal, Team, and Group chat).
    4. Choose Save
  5. Choose Publish
    1. Choose Download the app package to download a zip file to your computer.
  6. Choose Preview in Teams to Microsoft Teams (work or school) app
    1. From the Microsoft Teams left navigation bar, choose Apps, then Manage your apps, then ⤒ Upload an app
    2. Choose Upload an app to your orgs app catalog, and select the zip file downloaded in the previous step. This adds the app to Teams.
    3. Select the card for your new app and choose Add.

And, now, at last, you can test your bot in Microsoft Teams!

Add your bot to one or more Teams

To use your Amazon Q business expert app in your team channels, first add it to each team:

  1. In the Teams app, select your Team and choose 'Manage team'
  2. In the Apps tab, choose the new Amazon Q app, and Add.

Teams Demo

Say hello

Time to say Hi!

  1. Go to Teams
  2. Under Apps add your new Amazon Q business expert app to a Chat
  3. Optionally add your app to one or more Team channels
  4. In the app DM chat, say Hello. In a team channel, ask it for help with an @mention.
  5. You'll be prompted in DM chat to Sign In with your Okta credentials to authenticate with Amazon Q. Click the button to sign in.
  6. You'll be redirected to browser to sign in with Okta. Once you sign in, you can close the browser window and return to Microsoft Teams.
  7. You're now authenticated and can start asking questions!
  8. Enjoy.

Contributing, and reporting issues

We welcome your contributions to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

See CONTRIBUTING for more information.

Security

See Security issue notifications for more information.

License

This library is licensed under the MIT-0 License. See the LICENSE file.

About

License:MIT No Attribution

Languages

Language:TypeScript 76.4%Language:Shell 13.6%Language:JavaScript 10.0%