Complete the prerequisites for foundation models in SageMaker Canvas

The following sections outline the prerequisites for interacting with foundation models and using the document query feature in Canvas. The rest of the content on this page assumes that you’ve met the prerequisites for foundation models. The document query feature requires additional permissions.

Prerequisites for foundation models

The permissions you need for interacting with models are included in the Canvas Ready-to-use models permissions. To use the generative AI-powered models in Canvas, you must turn on the Canvas Ready-to-use models configuration permissions when setting up your Amazon SageMaker AI domain. For more information, see Prerequisites for setting up Amazon SageMaker Canvas. The Canvas Ready-to-use models configuration attaches the AmazonSageMakerCanvasAIServicesAccess policy to your Canvas user's AWS Identity and Access Management (IAM) execution role. If you encounter any issues with granting permissions, see the topic Troubleshooting issues with granting permissions through the SageMaker AI console.

If you’ve already set up your domain, you can edit your domain settings and turn on the permissions. For instructions on how to edit your domain settings, see Edit domain settings. When editing the settings for your domain, go to the Canvas settings and turn on the Enable Canvas Ready-to-use models option.

Certain JumpStart foundation models also require that you request a SageMaker AI instance quota increase. Canvas hosts the models that you’re currently interacting with on these instances, but the default quota for your account may be insufficient. If you run into an error while running any of the following models, request a quota increase for the associated instance types:

For the preceding instances types, request an increase from 0 to 1 for the endpoint usage quota. For more information about how to increase an instance quota for your account, see Requesting a quota increase in the Service Quotas User Guide.

Prerequisites for document querying

The document querying feature requires that you already have an Amazon Kendra index that stores your documents and document metadata. For more information about Amazon Kendra, see the Amazon Kendra Developer Guide. To learn more about the quotas for querying indexes, see Quotas in the Amazon Kendra Developer Guide.

You must also make sure that your Canvas user profile has the necessary permissions for document querying. The AmazonSageMakerCanvasFullAccess policy must be attached to the AWS IAM execution role for the SageMaker AI domain that hosts your Canvas application (this policy is attached by default to all new and existing Canvas user profiles). You must also specifically grant document querying permissions and specify access to one or more Amazon Kendra indexes.

If your Canvas administrator is setting up a new domain or user profile, have them set up the domain by following the instructions in Prerequisites for setting up Amazon SageMaker Canvas. While setting up the domain, they can turn on the document querying permissions through the Canvas Ready-to-use models configuration.

The Canvas administrator can manage document querying permissions at the user profile level as well. For example, if the administrator wants to grant document querying permissions to some user profiles but remove permissions for others, they can edit the permissions for a specific user.

The following procedure shows how to turn on document querying permissions for a specific user profile:

You should now be able to use Canvas foundation models to query documents in the specified Amazon Kendra indexes.