Connecting Amazon Q Business to Quip using the console - Amazon Q Business

Connecting Amazon Q Business to Quip using the console

The following procedure outlines how to connect Amazon Q Business to Quip using the AWS Management Console.

Connecting Amazon Q to Quip

  1. Sign in to the AWS Management Console and open the Amazon Q console at https://console.aws.amazon.com/amazonq/business/.

  2. Complete the steps to create your Amazon Q application.

  3. Complete the steps for selecting an Amazon Q retriever.

  4. Then, from Data sources – Add an available data source to connect your Amazon Q application.

    You can add up to 5 data sources.

  5. Then, on the Quip page, enter the following information:

  6. Name – Name your data source for easy tracking.

    Note: You can include hyphens (-) but not spaces. Maximum of 1,000 alphanumeric characters.

  7. Source – Enter your Quip domain name. You can find your domain name in the browser URL of your Quip. For example, https://quip-company.quipdomain.com/browse, the domain is "quipdomain".

  8. Authorization – Amazon Q Business crawls ACL information by default to ensure responses are generated only from documents your end users have access to. See Authorization for more details.

  9. Authentication – Enter the following information for your AWS Secrets Manager secret.

    1. Secret name – A name for your secret.

    2. Quip token – Enter the Quip personal access token you created in your Quip account.

  10. Configure VPC and security group – optional – Choose whether you want to use a VPC. If you do, enter the following information:

    1. Subnets – Select up to 6 repository subnets that define the subnets and IP ranges the repository instance uses in the selected VPC.

    2. VPC security groups – Choose up to 10 security groups that allow access to your data source. Ensure that the security group allows incoming traffic from Amazon EC2 instances and devices outside your VPC. For databases, security group instances are required.

    For more information, see VPC.

  11. IAM role – Choose an existing IAM role or create an IAM role to access your repository credentials and index content.

    For more information, see IAM role.

  12. In Sync scope, enter the following information:

    1. Add Quip folder IDs to crawl – Enter the Quip folder IDs you want to crawl. You can find your folder ID in the browser URL when you access your folder in Quip. For example, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name, the folder ID is "zlLuOVNSarTL"..

      Note

      To crawl a root folder, including all sub-folders and documents inside it, input the root folder ID. To crawl specific sub-folders, add the specific sub-folder IDs.

    2. For Maximum single file size – Specify the file size limit in MBs that Amazon Q will crawl. Amazon Q will crawl only the files within the size limit you define. The default file size is 50MB. The maximum file size should be greater than 0MB and less than or equal to 50MB.

    3. (Optional) Additional configuration – optional – Configure the following settings:

      • Content types – Choose between crawling All content, File comments, Chat rooms and Attachments.

      • Regex patterns – Add regex patterns to include or exclude file names, file types, or file paths. You can have a total of 100 patterns.

  13. For Sync mode, choose how you want to update your index when your data source content changes. When you sync your data source with Amazon Q for the first time, all content is synced by default.

    • Full sync – Sync all content regardless of the previous sync status.

    • New, modified, or deleted content sync – Sync only new, modified, and deleted documents.

  14. In Sync run schedule, for Frequency – Choose how often Amazon Q will sync with your data source. For more details, see Sync run schedule.

  15. Tags - optional – Add tags to search and filter your resources or track your AWS costs. See Tags for more details.

  16. Field mappings – A list of data source document attributes to map to your index fields. Add the fields from the Data source details page after you finish adding your data source. You can choose from two types of fields:

    1. Default – Automatically created by Amazon Q on your behalf based on common fields in your data source. You can't edit these.

    2. Custom – Automatically created by Amazon Q on your behalf based on common fields in your data source. You can edit these. You can also create and add new custom fields.

      Note

      Support for adding custom fields varies by connector. You won't see the Add field option if your connector doesn't support adding custom fields.

    For more information, see Field mappings.

  17. To finish connecting your data source to Amazon Q, select Add data source.

    You are taken to the Data source details, where you can view your data source configuration details.

  18. In Data source details, choose Sync now to allow Amazon Q to begin syncing (crawling and ingesting) data from your data source. When the sync job finishes, your data source is ready to use.

    Note

    You can also choose to view CloudWatch logs for your data source sync job by selecting View CloudWatch logs. If you get a Resource not found exception when you try to view your CloudWatch logs for a data source sync job in progress, it can be because the CloudWatch logs are not available yet. Wait for some time and check again.