Unlock the information in your Slack workspace with Slack connector for Amazon Q Enterprise

Amazon Q Enterprise is a completely managed, generative AI-powered assistant that you may configure to reply questions, present summaries, generate content material, and full duties based mostly in your enterprise knowledge. Amazon Q Enterprise gives over 40 built-in connectors to widespread enterprise functions and doc repositories, together with Amazon Easy Storage Service (Amazon S3), Salesforce, Google Drive, Microsoft 365, ServiceNow, Gmail, Slack, Atlassian, and Zendesk and might help you create your generative AI answer with minimal configuration.

Practically 100 thousand organizations use Slack to carry the suitable folks collectively to securely collaborate with one another. A Slack workspace captures invaluable organizational information within the type of the data that flows by it because the customers talk on it. Therefore, it’s beneficial to make this information shortly and securely out there to the customers.

On this put up, we’ll show the right way to arrange Slack connector for Amazon Q Enterprise to sync communications from each private and non-private channels, reflective of person permissions. We can even information you thru the configurations wanted in your Slack workspace. Moreover, you’ll discover ways to configure the Amazon Q Enterprise software and allow person authentication by AWS IAM Id Middle, which is a really helpful service for managing a workforce’s entry to AWS functions.

Information supply overview

Amazon Q Enterprise makes use of massive language fashions (LLMs) to construct a unified answer that connects a number of knowledge sources. Sometimes, you’d want to make use of a pure language processing (NLP) method referred to as Retrieval Augmented Technology (RAG) for this. With RAG, generative AI enhances its responses by incorporating related data retrieved from a curated dataset. Amazon Q Enterprise has a built-in managed RAG functionality designed to cut back the undifferentiated heavy lifting concerned in creating these techniques. Typical of a RAG mannequin, Amazon Q Enterprise has two elements: A retrieval part that retrieves related paperwork for the person question and a technology part that takes the question and the retrieved paperwork after which generates a solution to the question utilizing an LLM.

A Slack workspace has a number of parts. It has public channels the place workspace customers can take part and personal channels the place solely channel members can talk with one another. People may instantly talk with one another in one-on-one conversations and in person teams. This communication is within the type of messages and threads of replies, with non-obligatory doc attachments. Slack workspaces of lively organizations are extremely dynamic, with the content material and collaboration evolving and rising in quantity repeatedly.

The previous determine exhibits the method circulate of the answer. Whenever you join Amazon Q Enterprise to a knowledge supply (on this case, Slack), what Amazon Q considers and crawls as a doc varies by connector. For the Amazon Q Enterprise Slack connector, every message, message attachment and channel put up is taken into account a single doc, Nevertheless, Slack dialog threads that enable you to create organized discussions round particular messages are additionally thought-about and ingested as a single doc, whatever the variety of individuals or messages they include.

Amazon Q Enterprise crawls entry management checklist (ACL) data connected to a doc (person and group data) out of your Slack occasion. This data can be utilized to filter chat responses to the person’s doc entry stage. The Slack connector helps token-based authentication. This might be a Slack bot person OAuth token or Slack person OAuth token. See the Slack connector overview to get the checklist of entities which are extracted, supported filters, sync modes, and file varieties.

Person IDs (_user_id) exist in Slack on messages and channels the place there are set entry permissions. They’re mapped from the person emails because the IDs in Slack.

To join your knowledge supply connector to Amazon Q Enterprise, you could give Amazon Q Enterprise an IAM position that has the next permissions:

• Permission to entry the BatchPutDocument and BatchDeleteDocument operations to ingest paperwork.
• Permission to entry the Person Retailer API operations to ingest person and group entry management data from paperwork.
• Permission to entry your AWS Secrets and techniques Supervisor secret to authenticate your knowledge supply connector occasion.
• (Elective) When you’re utilizing Amazon Digital Personal Cloud (Amazon VPC), permission to entry your Amazon VPC.

Resolution overview

On this answer, we’ll present you the right way to create a Slack workspace with customers who carry out numerous roles throughout the group. We are going to then present you the right way to configure this workspace to outline a set of scopes which are required by the Amazon Q Enterprise Slack connector to index the person communication. This will probably be adopted by the configuration of the Amazon Q Enterprise software and a Slack knowledge supply. Primarily based on the configuration, when the info supply is synchronized, the connector both crawls and indexes the content material from the workspace that was created on or earlier than a particular date. The connector additionally collects and ingests ACL data for every listed message and doc. Thus, the search outcomes of a question made by a person contains outcomes solely from these paperwork that the person is allowed to learn.

Stipulations

To construct the Amazon Q Enterprise connector for Slack, you want the next:

In Slack:

• Create a Slack bot person OAuth token or Slack person OAuth token. You may select both token to attach Amazon Q Enterprise to your Slack knowledge supply. See the Slack documentation on entry tokens for extra data.
• Be aware your Slack workspace group ID out of your Slack workspace principal web page URL. For instance, https://app.slack.com/consumer/T0123456789/... the place T0123456789 is the group ID.
• Add the OAuth scopes and browse permissions.

In your AWS account:

• Create an AWS Id and Entry Administration (IAM) position in your knowledge supply and, if utilizing the Amazon Q Enterprise API, word the ARN of the IAM position.
• Retailer your Slack authentication credentials in an AWS Secrets and techniques Supervisor secret and, if utilizing the Amazon Q Enterprise API, word the ARN of the key.
• Allow and configure an IAM Id Middle occasion. Amazon Q Enterprise integrates with IAM Id Middle as a gateway to handle person entry to your Amazon Q Enterprise software. We advocate enabling and pre-configuring an Id Middle occasion earlier than you start to create your Amazon Q Enterprise software. Id Middle is the really helpful AWS service for managing human person entry to AWS sources. Amazon Q Enterprise helps each group and account stage Id Middle cases. See Organising for Amazon Q Enterprise for extra data.

Configure your Slack workspace

You’ll create one person for every of the next roles: Administrator, Information scientist, Database administrator, Options architect and Generic.

To showcase the ACL propagation, you’ll create three public channels, #basic, #customerwork, and #random, that any member can entry together with the Generic person. Additionally, one personal channel, #anydepartment-project-private, that may be accessed solely by the customers arnav_desai, john_stiles, mary_major, and pat_candella.

To create a Slack app:

1. Navigate to the Slack API Your Apps web page and select Create New App.
   
2. Choose From scratch. Within the subsequent display screen, choose the workspace to develop your app, after which select Create an App.
   
3. Give the Slack app a reputation and choose a workspace to develop your app in. Then select Create App.
   
4. After you’ve created your app, choose it and navigate to Options and select OAuth & Permissions.
5. Scroll right down to Scopes > Person Token Scopes and set the OAuth scope based mostly on the person token scopes in Stipulations for connecting Amazon Q Enterprise to Slack.
   

Be aware: You may configure two forms of scopes in a Slack workspace:

1. Bot token scope: Solely the messages to which it has been explicitly added are crawled by the bot token. It’s employed to grant restricted entry to particular messages solely.
2. Person token scope: Solely the info shared with the member is accessible to the person token, which acts as a consultant of a Slack person.

For this instance, so you’ll be able to search on the conversations between customers, you’ll use the person token scope.

6. After the OAuth scope for yser token has been arrange as described within the Slack conditions, scroll as much as the part OAuth Tokens in your Workspace, and select Set up to Workspace, after which select Permit.
7. This can generate a person OAuth token. Copy this token to make use of when configuring the Amazon Q Enterprise Slack connector.
   

Configure the info supply utilizing the Amazon Q Enterprise Slack connector

On this part, you’ll create an Amazon Q Enterprise software utilizing the console.

To create an Amazon Q Enterprise software

1. Within the AWS Administration Console for Amazon Q Enterprise, select Create Software.
   
2. Enter an Software Title, akin to my-slack-workspace. Go away the Service entry because the default worth, and choose AWS IAM Id Middle for Entry Administration . Enter a brand new Tag worth as required and select Create to the Amazon Q Enterprise Software.
   
3. Go away the default possibility of Use Native retriever chosen for Retrievers, go away Enterprise because the Index provisioning and go away the default worth of 1 because the Variety of items. Every unit in Amazon Q Enterprise index is 20,000 paperwork or 200 MB of extracted textual content (whichever comes first). Select Subsequent.
   
4. Scroll down the checklist of accessible connectors and choose Slack after which select Subsequent.
   
   1. Enter a Information supply title and a Description to determine your knowledge supply after which enter the Slack workspace group ID to attach with Amazon Q Enterprise.
      
   2. Within the Authentication part, choose Create and add a brand new secret.
      
   3. On the dialog field that seems, enter a Secret title adopted by the Person OAuth Slack token that was copied from the Slack workspace.
      
   4. For the IAM position, choose Create a brand new service position (Advisable).
      
   5. In Sync scope, select the next:
      • For choose kind of content material to crawl, choose All channels.
      • Choose an acceptable date for Choose crawl begin date.
      • Go away the default worth chosen for Most file measurement as 50.
      • You may embrace particular Messages, akin to bot messages or archived messages to sync.
      • Moreover, you’ll be able to embrace as much as 100 patterns to incorporate or exclude filenames, varieties, or file paths to sync.

      

   6. For Sync mode, go away Full sync chosen and for the Sync run schedule, choose Run on demand.
      
   7. Go away the sphere mapping as is and select Add knowledge supply.
   8. On the following web page, select Subsequent.
5. Add the 5 customers you created earlier, who’re part of IAM Id Middle and the Slack workspace to the Amazon Q Enterprise software. So as to add customers to Id Middle, observe the directions in Add customers to your Id Middle listing. When finished, select Add teams and customers and select Assign.
   
6. When a person is added, every person is assigned the default Q Enterprise Professional For extra data on completely different pricing tiers, see the Amazon Q Enterprise pricing web page.
   
7. Select Create software to complete creating the Amazon Q Enterprise software.
8. After the appliance and the info supply are created, choose the info supply after which select Sync now to start out syncing paperwork out of your knowledge supply.
   
9. The sync course of ingests the paperwork out of your Slack workspace to your choices within the Slack connector configuration in Amazon Q Enterprise. The next screenshot exhibits the outcomes of a profitable sync, indicated by the standing of Accomplished.
   

Search with Amazon Q Enterprise

Now, you’re able to make a number of queries in Amazon Q Enterprise.

To go looking utilizing Amazon Q Enterprise:

1. Navigate to the Net expertise settings tab and click on on the Deployed URL.
2. For this demonstration, check in as pat_candella who has the position of DB Admin.
   
3. Enter the password for pat_candella and select Register
   
4. Upon profitable sign-in, you’ll be signed in to Amazon Q Enterprise.
   
5. Within the Slack workspace, there’s a public channel, the #customerwork channel that every one customers are members of. The #customerwork Slack channel is getting used to speak about an upcoming buyer engagement, as proven within the following determine.
   
6. Submit the primary query to Amazon Q Enterprise.

I'm presently utilizing Apache Kafka. Are you able to checklist excessive stage steps concerned in migration to Amazon MSK?

Be aware that the response contains citations that seek advice from the dialog in addition to the content material of the PDF that was connected to the dialog.

Safety and privateness choices with Slack knowledge connector

Subsequent, you’ll create a non-public channel referred to as #anydepartment-project-private with 4 out of the 5 customers—arnav_desai, john_stiles, mary_major and pat_candella—and confirm that the messages exchanged in a non-public channel should not out there to non-members like jane_doe. Be aware that after you create a brand new personal channel, it is advisable manually re-run the sync on the info supply.

The beneath screenshot exhibits the personal slack channel with 4 out of 5 customers and the slack dialog.

Testing safety and privateness choices with Slack knowledge connector

1. Whereas signed in as pat_candella, who’s a part of the personal #anydepartment-project-private channel, execute the next question:

   What's Amazon Kendra and which API do I take advantage of to question a Kendra index?

   

2. Now, check in as jane_doe, who is just not a member of the #anydepartment-project-private channel and execute the identical question.
   
3. Amazon Q Enterprise prevents jane_doe from getting insights from data throughout the personal channels that they aren’t a part of, based mostly on the synced ACL data.

fields LogLevel, DocumentId, DocumentTitle, CrawlAction, ConnectorDocumentStatus.Standing as ConnectorDocumentStatus, ErrorMsg, CrawlStatus.Standing as CrawlStatus, SyncStatus.Standing as SyncStatus, IndexStatus.Standing as IndexStatus, SourceUri, Acl, Metadata, HashedDocumentId, @timestamp

| filter @logStream like 'SYNC_RUN_HISTORY_REPORT/xxxxxxxxxxxxxxxxxxxxxxxx' and Metadata like /"stringValue":"C12AB34578"/

| type @timestamp desc

| restrict 10000