Improving Visibility and Troubleshooting with Amazon Q Business Document-Level Reports
Amazon Q Business is revolutionizing the way enterprises access and utilize their data and knowledge. With its generative AI-powered assistant, companies can now quickly find answers, generate summaries, and complete tasks by tapping into the wealth of information stored across their various data sources and systems. This capability is made possible by the native data source connectors that integrate and index content from multiple repositories into a unified index, allowing the large language model of Amazon Q to provide accurate and well-written answers.
One key feature that customers have been asking for is better visibility into the document processing lifecycle during data source sync jobs. They want to know the status of each document, troubleshoot issues, and access metadata, timestamps, and access control lists (ACLs). And now, Amazon Q Business has delivered with a new feature that significantly enhances visibility into data source sync operations.
The latest release includes a comprehensive document-level report incorporated into the sync history. This report provides administrators with granular indexing status, metadata, and ACL details for every document processed during a data source sync job. By offering this level of detail, administrators can quickly investigate and resolve ingestion or access issues encountered while setting up their Amazon Q Business application. The detailed document reports are stored in a dedicated log stream, making critical sync job details readily available for troubleshooting.
Lifecycle of a document in a data source sync run job
The data source sync in Amazon Q Business comprises three key stages: crawling, syncing, and indexing. During the crawling stage, the connector extracts documents from the data source while comparing checksums to determine if a document needs to be added, modified, or deleted from the index. The syncing stage involves submitting documents to the ingestion service APIs, and the indexing stage persists the documents in the index, making them searchable within the Amazon Q Business environment.
Key features and benefits of document-level reports
The new document-level report in Amazon Q Business applications offers a range of features and benefits:
- Enhanced sync run history page with an Actions column for access to the document-level report
- Dedicated log stream named SYNC_RUN_HISTORY_REPORT containing detailed document information
- Comprehensive document information including document ID, title, status, error messages, ACLs, metadata, and more
These features empower administrators to troubleshoot issues, verify permissions, and improve the accuracy and relevance of the information provided by Amazon Q Business.
Conclusion
The introduction of the document-level report in Amazon Q Business marks a significant advancement in the platform’s capabilities. This feature addresses the needs of customers for better visibility and troubleshooting during data source sync operations. By providing detailed information about each document processed, including status, metadata, and ACLs, Amazon Q Business enables organizations to make the most of their data and knowledge assets.
To learn more about Amazon Q Business and how it can transform your enterprise’s data access and utilization, explore the Getting Started guide and best practices for configuring data source connectors. With Amazon Q Business, you can unlock the full potential of your data and empower your organization with efficient and intelligent information retrieval.
About the authors
Aneesh Mohan, a Senior Solutions Architect at Amazon Web Services, brings extensive experience in creating solutions for business-critical workloads. His focus on technology and customer-centric solutions has made him a valuable asset in the industry.
Ashwin Shukla, a Software Development Engineer II on the Amazon Q for Business and Amazon Kendra engineering team, leverages his expertise in enterprise software development to design and develop foundational features for Amazon Q for Business.