Various organizations use Gmail for his or her enterprise e mail wants. Gmail for enterprise is a part of Google Workspace, which offers a set of productiveness and collaboration instruments like Google Drive, Gmail, and Google Calendar. Google Drive helps storing paperwork equivalent to Emails comprise a wealth of knowledge discovered somewhere else, equivalent to throughout the topic of an e mail, the message content material, and even attachments. Performing an clever search on emails with co-workers may help you discover solutions to questions, enhancing productiveness and enhancing the general buyer expertise for the group.
Amazon Q Enterprise is a totally managed, generative AI-powered assistant designed to boost enterprise operations. It may be tailor-made to particular enterprise wants by connecting to firm information, data, and methods by means of over 40 built-in connectors.
Amazon Q Enterprise permits customers in varied roles, equivalent to entrepreneurs, mission managers, and gross sales representatives, to have tailor-made conversations, clear up issues, generate content material, take motion, and extra, all by means of a web-based interface. This software goals to make staff work smarter, transfer sooner, and drive extra important influence by offering speedy and related data and streamlining duties.
With the Gmail connector for Amazon Q Enterprise, you possibly can improve productiveness and streamline communication processes inside your group. This integration empowers you to make use of superior search capabilities and clever e mail administration utilizing pure language.
On this submit, we information you thru the method of establishing the Gmail connector, enabling seamless interplay between Gmail and Amazon Q Enterprise. Whether or not you’re a small startup or a big enterprise, this answer may help you maximize the potential of your Gmail information and empower your group with actionable insights.
Discovering correct solutions from content material in Gmail mailbox utilizing Amazon Q Enterprise
After you combine Amazon Q Enterprise with Gmail, you possibly can ask a query and Amazon Q Enterprise can index by means of your mailbox and discover related solutions. For instance, you can also make the next queries:
- Pure language search – You may seek for emails and attachments inside your mailbox utilizing pure language, making it easy to search out your required data with out having to recollect particular key phrases or filters
- Summarization – You may request a concise abstract of the conversations and attachments matching your search question, permitting you to rapidly grasp the important thing factors with out having to manually sift by means of particular person objects
- Question clarification – In case your question is ambiguous or lacks adequate context, Amazon Q Enterprise can have interaction in a dialogue to make clear the intent, so that you obtain essentially the most related and correct outcomes
Overview of the Gmail connector for Amazon Q Enterprise
To crawl and index contents in Gmail, you possibly can configure the Gmail connector for Amazon Q Enterprise as an information supply in your Amazon Q Enterprise utility. Whenever you join Amazon Q Enterprise to a knowledge supply and provoke the sync course of, Amazon Q Enterprise crawls and indexes paperwork from the info supply into its index.
A knowledge supply connector is a mechanism for integrating and synchronizing information from a number of repositories into one container index. A knowledge supply is an information repository or location that Amazon Q Enterprise connects to with a purpose to retrieve your e mail information. After you arrange the connector, you possibly can create one or a number of information sources inside Amazon Q Enterprise and configure them to start out indexing emails out of your Gmail account.
Kinds of paperwork
Gmail messages will be sorted and saved inside your e mail inbox utilizing folders and labels.
Let’s appears to be like at what are thought-about as paperwork within the context of the Gmail connector for Amazon Q Enterprise. The connector helps the crawling of the next entities in Gmail:
- E mail – Every e mail is taken into account a single doc
- Attachment – Every e mail attachment is taken into account a single doc
Moreover, supported customized metadata and customized objects are additionally crawled in the course of the sync course of.
The Gmail connector for Amazon Q Enterprise additionally helps the indexing of a wealthy set of metadata from the varied entities in Gmail. It additional offers the flexibility to map these supply metadata fields to Amazon Q index fields for indexing. These subject mappings let you map Gmail subject names to Amazon Q index subject names. There are three kinds of metadata fields that Amazon Q connectors assist:
- Default fields – These are required with every doc, such because the title, creation date, or creator
- Optionally available fields – These are offered by the info supply, and the administrator can optionally select a number of of those fields in the event that they comprise vital and related data to provide correct solutions
- Customized metadata fields – These are fields created within the information supply along with what the info supply already offers
Confer with Gmail information supply connector subject mappings for extra data.
Authentication
Earlier than we index the content material from Gmail, we have to first set up a safe connection between the Gmail connector for Amazon Q Enterprise together with your Google service account. To ascertain a safe connection, we have to authenticate with the info supply.
The connector helps authentication utilizing a Google service account. We describe the method of making an account later on this submit. For extra details about authentication, see Gmail connector overview.
Safe querying with ACL crawling and id crawling
Safe querying is when a consumer runs a question and is returned solutions solely from paperwork that the consumer has entry to. To allow customers to do safe querying, Amazon Q Enterprise honors the entry management lists (ACLs) of the paperwork. Amazon Q Enterprise does this by first supporting the indexing of ACLs. Indexing paperwork with ACLs is essential for sustaining information safety, as a result of paperwork with out ACLs are thought-about public. Moreover, the consumer’s credentials (e mail handle) are handed together with the question in order that solutions from paperwork which can be related and which consumer is allowed to entry are displayed.
When connecting a Gmail information supply, Amazon Q Enterprise crawls the ACL data hooked up to a doc (consumer and group data) out of your Gmail occasion. In Gmail, consumer IDs are mapped to _user_id
. Person IDs exist in Gmail on recordsdata with set entry permissions. They’re mapped from the consumer emails because the IDs in Gmail.
When a consumer logs in to an internet utility to conduct a search, the consumer’s credentials, equivalent to an e mail handle, must match what’s within the ACL of the doc to return outcomes from that doc. The net utility that the consumer makes use of to retrieve solutions is linked to an id supplier (IdP) or AWS IAM Id Middle. The consumer’s credentials from the IdP or IAM Id Middle are referred to right here because the federated consumer credentials. The federated consumer credentials are handed together with the question in order that Amazon Q can return the solutions from the paperwork that this consumer has entry to.
Confer with How Amazon Q Enterprise connector crawls Gmail ACLs for extra data.
Resolution overview
Within the following sections, we show find out how to arrange the Gmail connector for Amazon Q Enterprise. Then we offer examples of find out how to use the AI-powered chat interface to realize insights from the linked information supply.
In our answer, we index emails from Gmail by configuring the Gmail information supply connector. This connector permits you to question your Gmail information utilizing Amazon Q Enterprise as your question engine.
After the configuration is full, you possibly can configure how usually Amazon Q Enterprise ought to synchronize together with your Gmail account to maintain updated with the e-mail content material. This course of makes certain that your e mail interactions are systematically up to date inside Amazon Q Enterprise, enabling you to question and uncover beneficial insights out of your Gmail information.
The next diagram illustrates the answer structure. Google Workspace is the info supply. Emails and attachments together with the ACL data are handed to Amazon Q Enterprise from the Google workspace. The consumer submits a question to the Amazon Q Enterprise utility. Amazon Q Enterprise retrieves the ACL of the consumer and offers solutions based mostly on the emails and attachments that the consumer has entry to.
Conditions
It is best to have the next:
Configure the Gmail connector for an Amazon Q Enterprise utility
To allow Amazon Q Enterprise to entry and index emails from Gmail accounts throughout the group, it’s important to configure the group’s Google workspace. Within the steps that comply with, we create a service account that might be utilized by the Gmail connector for Amazon Q Enterprise to index emails.
We offer the service account with authorization scopes to permit entry to the required Gmail APIs. The authorization scopes categorical the permissions you request customers to authorize to your utility and are relevant to emails inside your group’s Google workspace.
Full the next steps:
- Log in to your group’s Google Cloud account.
- Create a brand new mission with an applicable identify and assign it to your group. In our instance, we identify the mission
GmailConnector
. - Select Create.
- After you create the mission, on the navigation menu, select APIs and Providers and Library to view the API Library.
- On the API Library web page, seek for and select Admin SDK API.
The Admin SDK API permits managing the Google workspace account sources and audit utilization.
- Select Allow.
- Equally, seek for the Gmail API on the API Library
The Gmail API may help in viewing and managing the Gmail mailbox information like threads, messages, and labels.
- Select Allow to allow this API.
We now create a service account. The service account might be utilized by the Amazon Q Enterprise Gmail information supply connector to entry the group’s emails based mostly on the allowed API scope.
- On the navigation menu, select IAM and Admin and Service accounts.
- Select Create service account.
- Identify the service account
Amazon-q-integration-gmail
, enter an outline, and select Create and proceed. - Skip the non-obligatory sections Grant this service account entry to mission and Grant customers entry to this service account.
- Select Completed.
- Select the service account you created to navigate to the service account particulars web page.
- Word the distinctive ID for the service account—the distinctive ID is often known as the shopper ID, and might be utilized in later steps.
Subsequent, we create the keys for the service account, which can permit it for use by the Gmail connector for Amazon Q Enterprise.
- On the Keys tab, select Add key and Create new key.
- When prompted for the important thing kind, choose the beneficial possibility JSON and select Create.
This can obtain the non-public key to your pc, which have to be saved secure to permit configuration throughout the Amazon Q console. The next screenshot reveals an instance of the credentials JSON file.
- On the Particulars tab, develop the Superior settings part and select View Google Workspace Admin console within the Area-wide Delegation
Granting entry to the service account utilizing a domain-wide delegation to your group’s information have to be handled as a privileged operation and finished with warning. You may reverse the entry grant by disabling or deleting the service account or eradicating entry by means of the Google Workspace Admin console.
- Use the Google Workspace Admin credentials to log in to the Google Workspace Admin console.
- Underneath Safety on the navigation menu, underneath Entry and information management, select API controls.
- Within the Area-wide delegation part, select Handle domain-wide delegation.
- Select Add new.
- Within the Add a brand new shopper ID dialog, enter the distinctive ID for the service account you created.
- Enter the next scopes to permit the service account to entry the emails from Gmail:
- https://www.googleapis.com/auth/gmail.readonly – This scope permits to you to view your e mail messages and settings.
- https://www.googleapis.com/auth/admin.listing.consumer.readonly – This scope permits to see and obtain your group’s Google Workspace listing.
For extra particulars about all of the scopes obtainable, discuss with OAuth 2.0 Scopes for Google APIs.
- Select Authorize.
This concludes the configuration throughout the Google Cloud console and Google Workspace Admin console.
Create the Gmail connector for an Amazon Q Enterprise utility
This submit assumes that an Amazon Q Enterprise utility has already been created beforehand. In the event you haven’t created one but, discuss with Construct non-public and safe enterprise generative AI apps with Amazon Q Enterprise and AWS IAM Id Middle for directions.
Full the next steps to configure the connector:
- On the Amazon Q Enterprise console, select Purposes within the navigation pane.
- Choose the applying that you simply wish to add the Gmail connector to.
- On the Actions menu, select Edit.
- On the Replace utility web page, depart all values unchanged and select Replace.
- On the Replace retriever web page, depart all values as default and select Subsequent.
- On the Join information sources web page, on the All tab, seek for Gmail within the search subject.
- Select the plus signal subsequent to Gmail, which can open up a web page to arrange the info supply.
- Within the Identify and outline part, enter a reputation and outline.
- Within the Authentication part, select Create and add new secret.
- Within the Create an AWS Secrets and techniques Supervisor secret pop-up, present the next data:
- Enter a reputation to your Secrets and techniques Supervisor secret.
- For Consumer e mail and Personal key, discuss with the JSON file that you simply downloaded to your native machine earlier.
- For Admin account e mail, enter the admin account to your Google
- For Personal key, enter the non-public key particulars.
- Select Save.
- Within the IAM function part, for IAM function, select Create a brand new service function (beneficial).
- Within the Sync scope part, choose Message attachments and enter a worth for Most file dimension.
- Optionally, configure the next underneath Further configuration (we depart every little thing as default for this submit):
- For Date vary, enter the beginning and finish dates for emails to be crawled. Emails acquired on or after the beginning date and earlier than the tip date are included within the sync scope.
- For E mail domains, enter the e-mail from domains, e mail to domains, topic, CC emails, and BCC emails you wish to embrace or exclude in your index.
- For Key phrases in topics, embrace or exclude any paperwork with a minimum of one key phrase talked about of their topics
- For Labels, add common expression patterns to incorporate or exclude sure labels or attachment sorts. You may add as much as 100 patterns.
- For Attachments, add common expression patterns to incorporate or exclude sure attachments. You may add as much as 100 patterns.
- Within the Sync mode part, choose New, modified, or deleted content material sync.
- Within the Sync run schedule part, select the frequency that works greatest to your use case. For this submit, we select Run on demand.
- Select Add information supply and look ahead to the retriever to be created.
After the info supply is created, you’re redirected to the Join information sources web page so as to add extra information sources as wanted.
- Confirm your information supply is added and select Subsequent.
- On the Replace teams and customers web page, select Add teams and customers.
The customers and teams that you simply add on this part are from the IAM Id Middle customers and teams arrange by your administrator.
- Within the Add or assign customers and teams pop-up window, choose Assign current customers and teams so as to add current customers configured in your linked IAM Id Middle, then select Subsequent.
Optionally, when you have permissions so as to add customers to linked IAM Id Middle, you possibly can choose Add new customers.
- Select Get began.
- Seek for customers by consumer show identify or teams by group identify.
- Select the customers or teams you need you add and select Assign.
The teams and customers that you simply added ought to now be obtainable on the Teams or Customers tabs.
- Select Assign.
For every group or consumer entry, an Amazon Q Enterprise subscription tier must be assigned.
- To allow a subscription for a bunch, on the Replace teams and customers web page, select the Teams tab (if particular person customers must be assigned a subscription, select the Customers tab).
- Underneath the Subscription column, choose Select subscription and select a subscription (Q Enterprise Lite or Q Enterprise Professional).
- Select Replace utility to finish including and establishing the Gmail connector for Amazon Q Enterprise.
Configure Gmail subject mappings
That will help you construction information for retrieval and chat filtering, Amazon Q Enterprise crawls information supply doc attributes or metadata and maps them to fields in your Amazon Q index. Amazon Q has reserved fields that it makes use of when querying your utility. When potential, Amazon Q mechanically maps these built-in fields to attributes in your information supply.
If a built-in subject doesn’t have a default mapping, or if you wish to map further index fields, use the customized subject mappings to specify how an information supply attribute maps to your Amazon Q utility.
- On the Amazon Q Enterprise console, select your utility.
- Underneath Information sources, choose your information supply.
- On the Actions menu, select Edit.
- Within the Discipline mappings part, choose the required fields to crawl underneath Messages and Message attachments and any sorts which can be obtainable.
The Gmail connector setup for Amazon Q Enterprise is now full.
To check the connectivity to Gmail and provoke the info synchronization, select Sync now. The preliminary sync course of could take a number of minutes to finish.
When the sync is full, within the Sync run historical past part, you possibly can see the sync standing together with a abstract of how could complete objects had been added, deleted, modified, and failed in the course of the sync course of.
Question Gmail information utilizing the Amazon Q internet expertise
Now that the info synchronization is full, you can begin exploring insights from Amazon Q. Within the newly created Amazon Q utility, select Customise internet expertise to open a brand new tab with a preview of the UI and choices to customise as per your wants.
You may customise the Title, Subtitle, and Welcome message fields in keeping with your wants, which might be mirrored within the UI.
For this walkthrough, we use the defaults and select View internet expertise to be redirected to the login web page for the Amazon Q utility.
Log in to the applying utilizing the credentials for the consumer that had been added to the Amazon Q utility. After the login is profitable, you’re redirected to the Amazon Q assistant UI, the place you possibly can ask questions utilizing pure language and get insights out of your Gmail index.
The Gmail information supply linked to this Amazon Q Enterprise utility has e mail and Gmail attachments. We show how the Amazon Q utility helps you to ask questions in your e mail utilizing pure language and obtain responses and insights for these queries.
Let’s start by asking Amazon Q to summarize key factors from Matt Garma’s (CEO of AWS) e mail. The next screenshot shows the response and it additionally consists of the e-mail supply from the place it’s producing the response.
For our subsequent instance, let’s ask Amazon Q to supply particulars about return challenge buyer is going through for a bicycle order they positioned with Amazon. Following screenshot reveals the small print in regards to the challenge being confronted by the client and consists of the e-mail supply from the place Amazon Q is producing the response.
Troubleshooting
Troubleshooting your Amazon Q Enterprise Gmail connector offers details about error codes you would possibly see for the Gmail connector and advised troubleshooting actions. In the event you encounter an HTTP standing code 403 (Forbidden) error while you open your Amazon Q Enterprise utility, it implies that the consumer is unable to entry the applying. . See Troubleshooting Amazon Q Enterprise and id supplier integration for widespread causes and find out how to handle them.
Regularly requested questions
On this part, we offer steerage to often requested questions.
Amazon Q Enterprise is unable to reply your questions
This might occur resulting from a a number of causes:
- No permissions – ACLs utilized to your account doesn’t let you question sure information sources. If that is so, attain out to your utility administrator to ensure your ACLs are configured to entry the info sources.
- Information connector sync failed – The information connector might need didn’t sync data from the supply to the Amazon Q Enterprise utility. Confirm the info connector’s sync run schedule and sync historical past to verify the sync is profitable.
If neither of those causes are true in your case, open a assist case to get this resolved.
Find out how to generate responses from authoritative information sources
You may configure these choices utilizing Amazon Q Enterprise utility international controls underneath Admin controls and guardrails.
- Log in as an Amazon Q Enterprise utility administrator.
- Navigate to the applying and select Admin controls and guardrails within the navigation pane.
- Select Edit within the International controls part to regulate these choices.
For extra data, discuss with Admin controls and guardrails in Amazon Q Enterprise.
Amazon Q Enterprise responds utilizing outdated (stale) information regardless that your information supply is up to date
Every Amazon Q Enterprise information connector will be configured with distinctive sync run schedule frequency. Confirm the sync standing and sync schedule frequency to your information connector to see when the final sync ran efficiently. Your information connector’s sync run schedule could possibly be set to sync at a scheduled time of day, week, or month. If it’s set to run on demand, the sync must be run manually. When the sync run is full, confirm the sync historical past to ensure the run has efficiently synced all new points. Confer with Sync run schedule for extra data on every possibility.
Find out how to arrange Amazon Q Enterprise utilizing a distinct IdP
You may arrange Amazon Q Enterprise with one other SAML 2.0-compliant IdP, equivalent to Okta, Entra ID, or Ping Id. For extra data, see Creating an Amazon Q Enterprise utility utilizing Id Federation by means of IAM.
Develop the answer
You may discover different options in Amazon Q Enterprise. For instance, the Amazon Q Enterprise doc enrichment characteristic helps you management each which paperwork and doc attributes are ingested into your index and the way they’re ingested. With doc enrichment, you possibly can create, modify, or delete doc attributes and doc content material while you ingest them into your Amazon Q Enterprise index. For instance, you possibly can scrub personally identifiable data (PII) by selecting to delete any doc attributes associated to PII.
Amazon Q Enterprise additionally gives the next options:
- Filtering utilizing metadata – Use doc attributes to customise and management customers’ chat expertise. That is presently supported provided that you employ the Amazon Q Enterprise API.
- Supply attribution with citations – Confirm responses utilizing Amazon Q Enterprise supply attributions.
- Add recordsdata and chat – Let customers add recordsdata straight into chat and use uploaded file information to carry out internet expertise duties.
- Fast prompts – Characteristic pattern prompts to tell customers of the capabilities of their Amazon Q Enterprise internet expertise.
To enhance retrieved outcomes and customise the consumer chat expertise, you possibly can map doc attributes out of your information sources to fields in your Amazon Q index. To study extra, see Gmail information supply connector subject mappings.
Clear up
To keep away from incurring future prices, clear up any sources you created as a part of this answer, together with the Amazon Q utility:
- On the Amazon Q console, select Purposes within the navigation pane.
- Choose the dashboard you created.
- On the Actions menu, select Delete.
- Delete the IAM roles created for the applying and information retriever.
- In the event you used IAM Id Middle for this walkthrough, delete your IAM Id Middle occasion.
Conclusion
On this submit, we mentioned find out how to configure the Gmail connector for Amazon Q Enterprise and use the AI-powered chat interface to realize insights from the linked information supply.
To study extra in regards to the Gmail connector for Amazon Q Enterprise, discuss with Connecting Gmail to Amazon Q Enterprise, the Amazon Q Person Information, and the Amazon Q Developer Information.
Concerning the Authors
Divyajeet (DJ) Singh is a Sr. Options Architect at AWS Canada. He loves working with clients to assist them clear up their distinctive enterprise challenges utilizing the cloud. In his free time, he enjoys spending time with household and buddies, and exploring new locations.
Temi Aremu is a Options Architect at AWS Canada. She is enthusiastic about serving to clients clear up their enterprise issues with the ability of the AWS Cloud. Temi’s areas of curiosity are analytics, machine studying, and empowering the subsequent era of ladies in STEM.
Vineet Kachhawaha is a Sr. Options Architect at AWS specializing in AI/ML and generative AI. He co-leads the AWS for Authorized Tech group inside AWS. He’s enthusiastic about working with enterprise clients and companions to design, deploy, and scale AI/ML functions to derive enterprise worth.
Vijai Gandikota is a Principal Product Supervisor within the Amazon Q and Amazon Kendra group of Amazon Net Providers. He’s chargeable for the Amazon Q and Amazon Kendra connectors, ingestion, safety, and different facets of the Amazon Q and Amazon Kendra companies.
Dipti Kulkarni is a Software program Improvement Supervisor on the Amazon Q and Amazon Kendra engineering group of Amazon Net Providers, the place she manages the connector improvement and integration groups.