Connecting data sources to an Amazon Q Business application
After you select a retriever for your Amazon Q Business application environment, you connect data sources to it. Available data sources vary based on your choice of the retriever.
If you use an Amazon Q Business retriever, you can choose from the following options:
-
Connect to any Amazon Q Business supported data source connectors by using the CreateDataSource API operation.
-
Upload documents directly by using the BatchPutDocument API operation.
If you use an existing Amazon Kendra retriever, only data sources already connected to your Amazon Kendra index are available in your application environment.
To connect data sources, choose a topic based on your data source preference for your Amazon Q Business application environment:
Topics
Upload documents
To upload documents directly to an Amazon Q Business application environment, you can use the AWS Management Console or the BatchPutDocument API operation.
If you use an Amazon Kendra index to retrieve your documents, you can't directly upload documents.
The following tabs provide a procedure for the AWS Management Console and code examples for the AWS CLI.
Connecting an Amazon Kendra retriever to an Amazon Q Business application
To use an Amazon Kendra index as a retriever for Amazon Q Business, you must have already configured an Amazon Kendra index and connected it with data. For more information, see What is Amazon Kendra? and Are you a first-time Amazon Kendra user? in the Amazon Kendra Developer Guide.
To add an existing Amazon Kendra retriever to your Amazon Q Business application environment, you can use the AWS Management Console or the CreateRetriever API operation. If you use the console, selecting and connecting an Amazon Kendra retriever is a two-step process. The first step is when you select an Amazon Kendra retriever. In this topic, you perform the second step—connecting an Amazon Kendra retriever.
If you use the API, you create your web experience after connecting your Amazon Kendra retriever using the CreateWebExperience API operation. If you use the console, connecting your Amazon Kendra retriever also automatically creates your Amazon Q Business web experience. At the end of the retriever connection process, your Amazon Kendra powered Amazon Q Business web experience is ready to be previewed, enhanced, and deployed.
Note
If you select an Amazon Kendra retriever, data in your Amazon Kendra is connected to your Amazon Q Business application environment.
Note
For information on managing your Amazon Kendra retriever, see Managing Amazon Kendra retrievers.
Amazon Q Business data sources
To connect a data source to your Amazon Q Business application environment, you can use the AWS Management Console or the CreateDataSource API operation.
By using the CreateDataSource
API operation, you can configure tags,
sync run schedules, and configure Amazon VPC settings. Then, you can use the
configuration
parameter to provide all other configuration
information specific to your data source connector.
If you use the console, creating the data source and configuring it are a single step. After your data source is successfully configured and added, Amazon Q automatically creates a Amazon Q Business web experience for you.
If you use the API, you use the CreateWebExperience API operation after connecting your data sources to create your web experience.
Note
This procedure is available if you chose the Use native retriever option to configure your application environment.