Amazon Q Enterprise is a generative AI-powered assistant designed to reinforce enterprise operations. It’s a completely managed service that helps present correct solutions to customers’ questions whereas adhering to the safety and entry restrictions of the content material. You’ll be able to tailor Amazon Q Enterprise to your particular enterprise wants by connecting to your organization’s data and enterprise programs utilizing built-in connectors to a wide range of enterprise information sources. It permits customers in varied roles, equivalent to advertising and marketing managers, challenge managers, and gross sales representatives, to have tailor-made conversations, remedy enterprise issues, generate content material, take motion, and extra, by an internet interface. This service goals to assist make workers work smarter, transfer sooner, and drive important affect by offering instant and related data to assist them with their duties.
One such enterprise information repository you need to use to retailer and handle content material is Google Drive. Google Drive is a cloud-based storage service that gives a centralized location for storing digital belongings, together with paperwork, information articles, and spreadsheets. This service helps your groups collaborate successfully by enabling the sharing and group of vital information throughout the enterprise. To make use of Google Drive inside Amazon Q Enterprise, you possibly can configure the Amazon Q Enterprise Google Drive connector. This connector permits Amazon Q Enterprise to securely index information saved in Google Drive utilizing entry management lists (ACLs). These ACLs make it possible for customers solely entry the paperwork they’re permitted to view, permitting them to ask questions and retrieve data related to their work instantly by Amazon Q Enterprise.
This publish covers the steps to configure the Amazon Q Enterprise Google Drive connector, together with authentication setup and verifying the safe indexing of your Google Drive content material.
Index Google Drive paperwork utilizing the Amazon Q Google Drive connector
The Amazon Q Google Drive connector can index Google Drive paperwork hosted in a Google Workspace account. The connector can’t index paperwork saved on Google Drive in a private Google Gmail account. Amazon Q Enterprise can authenticate together with your Google Workspace utilizing a service account or OAuth 2.0 authentication. A service account permits indexing information for consumer accounts throughout an enterprise in a Google Workspace. Utilizing OAuth 2.0 authentication permits for crawling and indexing information in a single Google Workspace account. This publish reveals you methods to configure Amazon Q Enterprise to authenticate utilizing a Google service account.
Google prescribes that as a way to index a number of customers’ paperwork, the crawler should assist the potential to authenticate with a service account with domain-wide delegation. This permits the connector to index the paperwork of all customers in your drive and shared drives. Amazon Q Enterprise connectors solely crawl the paperwork that the Amazon Q Enterprise utility administrator specifies should be crawled. Directors can specify the paths to crawl, particular file identify patterns, or sorts. Amazon Q Enterprise doesn’t use buyer information to coach any fashions. All buyer information is listed solely within the buyer account. Additionally, Amazon Q Enterprise Connectors will solely index content material specified by the administrator. It gained’t index any content material by itself with out explicitly being configured to take action by the administrator of Amazon Q Enterprise.
You’ll be able to configure the Amazon Q Google Drive connector to crawl and index file sorts supported by Amazon Q Enterprise. Google Write paperwork are exported as Microsoft Phrase and Google Sheet paperwork are exported as Microsoft Excel in the course of the crawling part.
Metadata
Each doc has structural attributes—or metadata—hooked up to it. Doc attributes can embody data equivalent to doc title, doc writer, time created, time up to date, and doc sort.
If you join Amazon Q Enterprise to an information supply, it robotically maps particular information supply doc attributes to fields inside an Amazon Q Enterprise index. If a doc attribute in your information supply doesn’t have an attribute mapping already obtainable, or if you wish to map extra doc attributes to index fields, you need to use the customized area mappings to specify how an information supply attribute maps to an Amazon Q Enterprise index area. You’ll be able to create area mappings by modifying your information supply after your utility and retriever are created.
There are 4 default metadata attributes listed for every Google Drive doc: authors, supply URL, creation date, and final replace date. You can too choose extra reserved information area mappings.
Amazon Q Enterprise crawls Google Drive ACLs outlined in a Google Workspace for doc safety. Google Workspace customers and teams are mapped to the _user_id and _group_ids fields related to the Amazon Q Enterprise utility in AWS IAM Identification Middle. These consumer and group associations are persevered within the consumer retailer related to the Amazon Q Enterprise index created for crawled Google Drive paperwork.
Overview of ACLs in Amazon Q Enterprise
Within the context of information administration and generative AI chatbot functions, an ACL performs a vital function in managing who can entry data and what actions they will carry out inside the system. Additionally they facilitate information sharing inside particular teams or groups whereas proscribing entry to others.
On this resolution, we deploy an Amazon Q internet expertise to display that two enterprise customers can solely ask questions on paperwork they’ve entry to in keeping with the ACL. With the Amazon Q Enterprise Google Drive connector, the Google Workspace ACL will likely be ingested with paperwork. This permits Amazon Q Enterprise to manage the scope of paperwork that every consumer can entry within the Amazon Q internet expertise.
Authentication sorts
An Amazon Q Enterprise utility requires you to make use of IAM Identification Middle to handle consumer entry. Though it’s advisable to have an IAM Identification Middle occasion configured (with customers federated and teams added) earlier than you begin, you can too select to create and configure an IAM Identification Middle occasion in your Amazon Q Enterprise utility utilizing the Amazon Q console.
You can too add customers to your IAM Identification Middle occasion from the Amazon Q Enterprise console, if you happen to aren’t federating identification. If you add a brand new consumer, make it possible for the consumer is enabled in your IAM Identification Middle occasion and that they’ve verified their e mail ID. They should full these steps earlier than they will log in to your Amazon Q Enterprise internet expertise.
Your identification supply in IAM Identification Middle defines the place your customers and teams are managed. After you configure your identification supply, you possibly can search for customers or teams to grant them single sign-on entry to AWS accounts, functions, or each.
You’ll be able to have just one identification supply per group in AWS Organizations. You’ll be able to select one of many following as your identification supply:
Overview of resolution
With Amazon Q Enterprise, you possibly can configure a number of information sources to offer a central place to look throughout your doc repository. For our resolution, we display methods to index Google Drive information utilizing the Amazon Q Enterprise Google Drive connector. We full the next steps:
- Configure Google Workspace conditions.
- Configure an Amazon Q Enterprise utility.
- Join Google Drive to Amazon Q Enterprise.
- Create customers and index the information within the Google Drive.
- Run a pattern question to check the answer.
Configure Google Workspace conditions
For this resolution, Amazon Q will connect with a Google Workspace and crawl Google Drive paperwork owned by enterprise customers in several teams utilizing a service account. Full the next steps to configure your Google Workspace:
- Log in to the Google API console as an admin consumer.
- Select the dropdown menu subsequent to the search field, then select New Undertaking.
- Enter the challenge identify, select the Google group, and select Create.
The Google Drive and Admin SDK APIs should be enabled for Amazon Q to crawl Google Drive information.
- Seek for every API on the Google Cloud console and select Allow.
- Seek for Service Accounts to entry the IAM & Admin navigation pane and select Create Service Account.
- Enter the service account identify, service account ID, and outline, and select Completed.
- Select the e-mail of the service account created within the earlier step.
- On the Keys tab, select Add Key, then select Create New Key.
- For Key sort, choose JSON, and select Create to obtain and domestically save a brand new non-public key.
Now we allow domain-wide delegation for the 5 required API scopes on the Area-wide Delegation web page.
- Select Add new.
- Add the next comma delimited API scopes for shopper ID generated for the non-public key created within the earlier step:
https://www.googleapis.com/auth/drive.readonly,https://www.googleapis.com/auth/drive.metadata.readonly,https://www.googleapis.com/auth/admin.listing.group.readonly,https://www.googleapis.com/auth/admin.listing.consumer.readonly,https://www.googleapis.com/auth/cloud-platform - Select Authorize.
Now we create customers and add them to teams.
- Navigate to the Google Workspace Admin console and select Customers within the navigation pane.
- Select Add new consumer to create two new enterprise customers.
- Select Teams within the navigation pane.
- Select Create group to create two Google teams and add one enterprise consumer to every group.
- Add information that Amazon Q helps into every enterprise consumer’s Google Drive.
On this resolution, we add the Amazon 2020 annual report to the primary enterprise consumer’s Google Drive and add the Amazon 2021 annual report and Amazon 2022 annual report to the second enterprise consumer’s Google Drive.
The enterprise consumer that uploaded the Amazon 2021 annual report may share it with the opposite enterprise consumer’s Google group.
- Select the choices menu (three vertical dots) for the Google Drive file and select Share.
- Enter the identify of the opposite Google group and select Ship.
Create an Amazon Q Enterprise utility with a Google Drive connector
An Amazon Q Enterprise utility must be created with a Google Drive connector to crawl and index Google Drive information. To create an Amazon Q utility, full the next steps:
- On the Amazon Q console, select Purposes within the navigation pane.
- Select Create utility.
- For Software identify, enter a reputation.
- Go away utility configuration settings as defaults.
- Select Create.
- After the applying is created, select Information Sources.
- Then select Choose retriever and Affirm to make use of a Native retriever and Enterprise provisioning.
- After confirming retriever settings, select Add information supply, after which select the plus signal subsequent to Google Drive.
- Below Identify and outline, enter an information supply identify and elective description.
- Below Authentication, choose Google service account and select Create a brand new secret from the AWS Secrets and techniques Supervisor secret drop all the way down to create an AWS Secrets and techniques Supervisor secret.
- Enter a secret identify, admin account e mail, shopper e mail, and the JSON key you downloaded earlier, then select Save.
- Below IAM function, select Create a brand new service function.
- Below Extra Configuration, select Person e mail, and add the 2 lately created Google Workspace enterprise consumer e mail addresses.
- Below Sync run schedule, for Frequency, select Run on demand.
- Select Add information supply.
Create and handle customers
To create an Amazon Q internet expertise accessible by Google Workspace customers, you could create corresponding customers in IAM Identification Middle. Amazon Q functions are solely accessible by IAM Identification Middle customers with consumer identities that personal listed paperwork. To create the IAM Identification Middle customers, full the next steps:
- On the IAM Identification Middle console, select Customers within the navigation pane.
- Select Add consumer.
- Create IAM Identification Middle customers that mirror your Google Workspace customers by getting into the required consumer data.
- Settle for the IAM Identification Middle invitation despatched by e mail to every new enterprise consumer and set every enterprise consumer’s IAM Identification Middle password.
- On the Amazon Q Enterprise console, navigate to the applying with the Google Drive information supply.
- Select Handle consumer entry.
- Select Add teams and customers, choose Assign current customers and teams, and select Subsequent.
- Assign customers to the Amazon Q utility, select Assign, and select Affirm if every enterprise consumer is subscribed to Q Enterprise Professional.
After you add IAM Identification Middle customers to your Amazon Q utility, its internet expertise URL will seem within the Q Enterprise functions checklist. You should use the URL to hook up with the Amazon Q internet expertise with both of your Google enterprise customers. By default, every consumer can solely ask questions on paperwork of their Google Drive.
Run pattern queries in Amazon Q
To check the Amazon Q utility with the Amazon annual reviews you uploaded to Google Drive, full the next steps:
- On the Amazon Q Enterprise console, navigate to the information supply you created.
- Run an on-demand sync of the information supply by selecting Sync now.
- Navigate to the internet expertise URL in a brand new non-public browser window and log in as the primary enterprise consumer.
- Ask Amazon Q a query, equivalent to what number of workers work at Amazon.
The supply paperwork must be the Amazon 2020 and 2021 annual reviews, assuming the primary enterprise consumer uploaded the Amazon 2020 annual report and the second enterprise consumer shared the Amazon 2021 annual report with the primary enterprise consumer.
- Navigate to the net expertise URL in a brand new non-public browser window and log in because the second enterprise consumer.
- Ask Amazon Q the identical query (what number of workers work at Amazon).
The supply paperwork must be the Amazon 2021 and 2022 annual reviews.
Troubleshooting
On this part, we share some frequent points and troubleshooting ideas.
IAM Identification Middle login error
You would possibly obtain an error on the IAM Identification Middle login web page that claims “We couldn’t confirm your sign-in credentials.”
To troubleshoot, full the next steps:
- Affirm that the enterprise customers that mirror the Google Workspace customers have been created in IAM Identification Middle.
- If the customers exist, navigate to the consumer in IAM Identification Middle and select Reset password, then choose Generate a one-time password and share the password with the consumer.
A password will likely be supplied for login and the consumer will likely be requested to vary their password after a profitable login.
Google Drive information supply crawling or indexing failure
If the Google Drive information supply crawling or indexing fails, full the next steps:
- Affirm the enterprise customers provisioned within the Google Workspace are members of the Google teams.
- Examine the Amazon CloudWatch logs for the final time the Google Drive information supply was crawled for customers with Google Drive information within the Google Workspace.
- If the crawler didn’t efficiently log the indexing of an anticipated consumer’s information, examine the IAM Identification Middle customers, then examine the attributes within the Secrets and techniques Supervisor secret to the corresponding Google Workspace attributes, together with shopper ID, service account e mail, and repair account non-public key.
- Use the Amazon Q Enterprise document-level sync reviews to verify the meant Google Drive paperwork have been listed by Amazon Q.
Google Drive information supply crawling and indexing job doesn’t crawl and index paperwork
If the Google Drive information supply crawling and indexing job doesn’t crawl and index any paperwork, full the next steps:
- Affirm the enterprise customers provisioned within the Google Workspace are members of the Google teams.
- Affirm there are IAM Identification Middle customers that mirror the Google Workspace customers.
- Affirm each IAM Identification Middle customers subscribe to Q Enterprise Professional.
- Affirm the Google Workspace admin consumer has enabled the Google Drive API.
Amazon Q internet expertise doesn’t return anticipated solutions from the anticipated supply
If the Amazon Q internet expertise doesn’t return anticipated solutions from the anticipated supply, full the next steps:
- Add the anticipated supply doc into an Amazon Q Enterprise chat session by selecting the paperclip icon within the Amazon Q chat interface after which selecting the file.
After you add the doc into the session, if the anticipated solutions are generated from the anticipated doc, the doc wasn’t efficiently listed from the Google Drive information supply.
- If Amazon Q doesn’t return the anticipated reply for the uploaded doc, modify the immediate used to ask the query.
Clear up
To stop incurring extra prices, it’s important to scrub up and take away any assets created in the course of the implementation of this resolution. Particularly, it’s best to delete the Amazon Q utility, which is able to consequently take away the related index and information connectors. Nonetheless, any Secrets and techniques Supervisor secrets and techniques created in the course of the Amazon Q utility setup course of should be eliminated individually. Failing to scrub up these assets could lead to ongoing expenses, so it’s essential to take the mandatory steps to fully take away all parts associated to this resolution.
Full the next steps to delete the Amazon Q utility, secret, and IAM Identification Middle customers in your AWS account:
- On the Amazon Q Enterprise console, select Purposes within the navigation pane.
- Choose the applying that you simply created and on the Actions menu, select Delete and make sure the deletion.
- On the Secrets and techniques Supervisor console, select Secrets and techniques within the navigation pane.
- Choose the key that was created for the Google Drive connector and on the Actions menu, select Delete.
- Specify the ready interval as 7 days and select Schedule deletion.
- On the IAM Identification Middle console, select Customers within the navigation pane.
- Choose the 2 customers that you simply created and select Delete customers to take away these customers.
Moreover, it’s best to take away the enterprise customers added to your Google Workspace in the course of the implementation of this resolution as a result of Google Workspaces prices are billed on a per-user foundation.
Conclusion
On this publish, you created an Amazon Q utility that listed Google Drive paperwork utilizing the Google Drive connector. You have been ready to hook up with the Amazon Q conversational interface as every of your online business customers and ask questions in regards to the paperwork every consumer may entry in accordance with the ACL.
You’ll be able to proceed to experiment by including extra PDF paperwork to your online business customers’ Google Drives and re-syncing your Amazon Q Google Drive information supply.
Amazon Q Enterprise gives different connectors, equivalent to for Confluence Cloud. To study extra in regards to the Amazon Q Enterprise Confluence Cloud connector, discuss with Connecting Confluence (Cloud) to Amazon Q Enterprise.
In regards to the Authors
Glen Eire is a Senior Enterprise Account Engineer at AWS within the Worldwide Public Sector. Glen’s areas of focus embody empowering prospects enthusiastic about constructing generative AI options utilizing Amazon Q.
Julia Hu is a Specialist Options Architect who helps AWS prospects and companions construct generative AI options utilizing Amazon Q Enterprise on AWS. Julia has over 4 years of expertise growing options for patrons adopting AWS providers on the forefront of cloud expertise.
