Skip to main content

Create a NetApp Connector for Amazon Q Business

Contributors netapp-mwallis
PDFs

After you've deployed the AI infrastructure and identified the data sources that you'll use from your FSx for ONTAP datastores, you are ready to define a NetApp Connector for Amazon Q Business.

Ensure that your environment meets the requirements for Amazon Q Business before proceeding.

About this task

Data sources from your organization might contain Personally Identifiable Information (PII). To safeguard this sensitive information, you can enable data guardrails when defining a connector. Data guardrails, powered by BlueXP classification, identifies and masks PII, making it inaccessible and irretrievable.

Learn about BlueXP classification.

Note BlueXP workload factory for GenAI does not mask sensitive personal information (SPII). Refer to types of sensitive personal data for more information about this type of data.
Note Data guardrails can be enabled or disabled at any time. If you switch data guardrails enablement, workload factory scans the entire data source from scratch, which can incur a cost.

Define a connector

Create a NetApp Connector for Amazon Q Business. The connector enables API and data source communication between GenAI and Amazon Q Business.

Steps

  1. Log in to workload factory using one of the console experiences.

  2. In the AI workloads tile, select Deploy & manage.

  3. From the Knowledge bases & Connectors tab, select the Create New dropdown and choose Amazon Q Business connector.

  4. On the Define Connector page, configure the connector settings:

    1. Name: Enter the name you want to use for the connector.

    2. Description: Enter a detailed description for the connector.

    3. Amazon Q: The region and application name for the Amazon Q Business instance you want to integrate.

    4. Data guardrails: Choose whether you want to enable or disable data guardrails. Learn about data guardrails, powered by BlueXP classification.

      The following prerequisites must be met to enable data guardrails.

      • A service account is required to communicate with BlueXP classification. You must have the Organization admin role on your BlueXP tenancy account for service account creation. A member who has the Organization admin role can complete all actions in BlueXP. Learn how to add a role to a member in BlueXP

      • The AI engine must have access to the BlueXP API endpoint.

      • You'll need to do the following as described in BlueXP classification documentation:

        1. Create a BlueXP Connector

        2. Ensure that your environment can meet the prerequisites

        3. Deploy BlueXP classification

    Note When you enable the data guardrails feature, GenAI processes .txt, .md, .csv, .docx, and .pdf files by ingesting only plain text (excluding embedded image or media text) and masking any private or sensitive data. All other file types are processed normally without masking private or sensitive data.

    1. FSx for ONTAP file system: When you define a new NetApp Connector for Amazon Q Business, workload factory creates a new Amazon FSx for NetApp ONTAP volume to store the connector information. Choose an existing file system and SVM (also called a storage VM) where the new volume will be created.

    2. Snapshot policy: Choose a snapshot policy from the list of existing policies defined in the workload factory storage inventory. GenAI automatically creates recurring snapshots of the volume storing the connector information at a frequency based on the snapshot policy you select.

      If the snapshot policy you need doesn't exist, you can create a snapshot policy on the storage VM that contains the volume.

  5. Select Create connector to integrate Amazon Q Business with GenAI.

    A progress indicator appears while the connector is created.

    After the connector is created, you have the option to add a data source to the connector so that Amazon Q Business ingests your data and adds it to its index. We recommend that you select Add data source and add one or more data sources now.

Add data sources to the connector

You can add one or more data sources to populate the Amazon Q Business index with your organization's data.

About this task

  • The maximum number of supported data sources is 10.

  • Refer to the Amazon Q Business documentation for specific service restrictions of the Amazon Q Business index.

Steps

  1. After you select Add data source, the Select a file system page appears.

  2. Select a file system: Select the FSx for ONTAP file system where your data source files reside and select Next.

  3. Select a volume: Select the volume on which your data source files reside and select Next.

    When selecting files stored using the SMB protocol, you'll need to enter the Active Directory information, which includes the domain, IP address, user name, and password.

  4. Select a data source: Select the data source location based on where you have saved the files. This can be an entire volume, or just a specific folder or sub-folder in the volume, and select Next.

  5. Configurations: Configure how the data source ingests information from your files, and which files it includes in scans:

    • File filtering: Configure which files are included in scans:

      • In the File types support section, choose to either include all types of files, or select individual file types for inclusion in the data source scans.

      • In the File modification time filter section, choose to enable or disable inclusion of files based on their modification time. If you enable modification time filtering, select a date range from the list.

        Note If you include files based on a modification date range, as soon as the date range is not satisfied (the files have not been modified within the date range you specify), the files will be excluded from the periodic scan, and the data source will not include these files.

  6. In the Permission aware section, which is available only when the data source you selected is on a volume that uses the SMB protocol, you can enable or disable permission-aware responses:

    • Enabled: Users of the chatbot who access this connector will only get responses to queries from data sources to which they have access.

    • Disabled: Users of the chatbot will receive responses using content from all integrated data sources.

      Note Active Directory group permissions are not supported for Amazon Q Business connector data sources.

  7. Select Add to add this data source to the Amazon Q Business connector.

Result

The data source is embedded into the Amazon Q Business index. The status changes from "Embedding" to "Embedded" when the data source is completely embedded.

After you add a single data source to the connector, you can test it in the Amazon Q Business chatbot environment and make any required changes before you make the service available to your users. You can also follow the same steps to add additional data sources to the connector.