Creating an Amazon Q Business retriever - Amazon Q Business

Creating an Amazon Q Business retriever

To select a Amazon Q Business retriever, you can use either the AWS Management Console, or the CreateIndex and CreateRetrieverAPI operations.

The following tabs provide a procedure for the AWS Management Console and code examples for the AWS CLI.

Console

To create an Amazon Q retriever

  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. Then, for Select retriever, choose Use native retriever – Build an Amazon Q Business retriever for your Amazon Q Business application. This option creates an Amazon Q Business index that can connect to the Amazon Q Business supported data sources that you choose.

    Note

    Available data sources when you select this option include all Amazon Q supported data connectors and direct document upload.

  4. In Index provisioning, do the following:

    1. Choose between Starter and Enterprise index types based on your use case. For more information on index types, see Index types.

    2. For Number of units – Choose the Number of units that you need. Amazon Q charges you based on the document capacity that you choose. If you choose an Enterprise index, You can choose up to 50 units. If you choose a Starter index, you can choose up to 5 units. Each unit is 20,000 documents or 200 MB, whichever is reached first. For more information on index provisioning pricing, see Amazon Q Business pricing.

  5. For Tags – Choose whether you want to add Index tags.

  6. To create your retriever and index, choose Create.

AWS CLI

To create an Amazon Q index


aws qbusiness create-index \
--application-id application-id \
--display-name display-name \
--description index-description \
--capacity-configuration units =<index-capacity-units> \
--type ENTERPRISE | STARTER

To create an Amazon Q retriever


aws qbusiness create-retriever \
--application-id application-id \
--display-name display-name \
--type NATIVE_INDEX \
--role-arn roleArn \
--configuration nativeIndexConfiguration="{indexId=<created-index-id>}" \    
--tags tags