Configuring Amazon Q Business Custom Connector with Alation
To build a generative AI-based conversational application integrated with relevant data sources, an enterprise needs to invest time, money, and people. This post shows how to configure an Amazon Q Business custom connector to crawl and index tasks from Alation, a data intelligence company serving more than 600 global enterprises.
Overview of a Custom Connector
A data source connector is a mechanism for integrating and synchronizing data from multiple repositories into one container index. Amazon Q Business offers multiple pre-built data source connectors that can connect to your data sources and help you create your generative AI solution with minimal configuration. However, if you have valuable data residing in spots for which those pre-built connectors cannot be used, you can use a custom connector.
Prerequisites
For this walkthrough, you should have the following prerequisites:
- Configure your Alation connection
- Create an OAuth2 client application that can be consumed from an Amazon Q Business application
- Sign in as a user with administrator privileges, navigate to the settings, and create a new client application
- In Alation, create an OAuth2 client application that can be consumed from an Amazon Q Business application
Solution Overview
The solution shown is for demonstration purposes only. We recommend running similar scripts only on your own data sources after consulting with the team who manages them, or be sure to follow the terms of service for the sources that you’re trying to fetch data from.
Troubleshooting
If you’re unable to get answers to any of your questions and get the message "Sorry, I could not find relevant information to complete your request," check to see if any of the following issues apply:
- No permissions: ACLs applied to your account don’t allow you to query certain data sources. If this is the case, please reach out to your application administrator to ensure your ACLs are configured to access the data sources.
- EmailID not matching UserID: In rare scenarios, a user might have a different email ID associated with the Amazon Q Business Identity Center connection than is associated in the data source’s user profile. Make sure that the Amazon Q Business user profile is updated to recognize the email ID using the update-user CLI command or the related API call.
- Data connector sync failed: Data connector fails to synchronize information from the source to Amazon Q Business application. Verify the data connectors sync run schedule and sync history to help ensure that the synchronization is successful.
- Empty or private data sources: Private or empty projects will not be crawled during the synchronization run.
Configuring the Amazon Q Business Custom Connector
To crawl and index contents in Alation, configure an Amazon Q Business custom connector as a data source in your Amazon Q Business application.
Case Study
In this post, we demonstrated how to integrate Alation’s business policies using a custom data source connector. We used Amazon Q Business to answer questions about the top sections of HR benefits policies and the data stewards for proprietary database sources.
Conclusion
In this post, we discussed how to configure the Amazon Q Business custom connector to crawl and index tasks from Alation. We showed how you can use Amazon Q Business generative AI-based search to enable your business leaders and agents discover insights from your enterprise data.
FAQs
- Q: What is a custom data source connector?
A: A custom data source connector is a mechanism for integrating and synchronizing data from multiple repositories into one container index. - Q: How do I configure the Amazon Q Business custom connector?
A: To configure the Amazon Q Business custom connector, you need to create an OAuth2 client application in Alation, sign in as a user with administrator privileges, and navigate to the settings to create a new client application. - Q: What are the prerequisites for using a custom data source connector?
A: The prerequisites for using a custom data source connector include configuring your Alation connection, creating an OAuth2 client application that can be consumed from an Amazon Q Business application, and signing in as a user with administrator privileges.
