Creating an Amazon SageMaker connection

Name of the endpoint.

The endpoint name is the identifier given for the endpoint on AWS. This is typically created by the user who sets up the endpoint or deploys a model.

Name of the deployed model.

This parameter is only required when a multi-model endpoint is deployed. For a simple endpoint, this parameter should not be provided as it will trigger an error from AWS.

Name of variant of the deployed model.

This parameter is only required when a multi-model endpoint is deployed. For a simple endpoint, this parameter should not be provided as it will trigger an error from AWS.

The following settings are available:

• AWS Region: Select the region you intend to use for the comprehend service.

• Use FIPS Endpoint: Specify if you need to use a FIPS compliant endpoint.

  This will only work if you choose a region that supports FIPS and for most users should be left as the default “No”.

Provide the AWS authentication Access key and Secret key for the Amazon Comprehend endpoints. These need to be created with access to the right policy permissions.

The authentication properties can be found in the AWS console and need to be input every time the connection needs to be re-authenticated.

Value of response format of the deployed machine learning model:

• JSON

• Text Array

Most models will return their data in JSON format, however some only return a text-based output. The option needs to be selected based on the type of model being deployed, otherwise this will result in a connection setting error.

• Name of Returned Table: Name of the returned table from the deployed machine learning model.

• Table Path (JMESPath): The Table can be specified by using the JMES table path to the predictions row in the JSON response array.

• Load all available fields: Enable loading of all available fields returned by the machine learning endpoint. Disabling this, will allow you to specify the table fields and values to load into the app.

  It is recommended to first load all fields returned from the model endpoint, and then potentially remove the fields that are not needed for the analysis in the app.

• Table Fields (JMESPath): The Table fields can be specified by adding:

  • Name: the name of the table that will be loaded in the app.

  • Value: the name of the response row in the JSON response array.

  JMESPath query language can be used to parse the JSON response array.

• Association Field: A field from the input data table containing a unique identifier.

  It is required to include this field in the source data when making an endpoint request for the results table returned to be associated with the source field table using a key. The designated field will be returned as a field in the response and enable the predictions to be associated with the source data in the data model. This can be any field with a unique ID, either from the source data or as part of the table load process.

• Send Association Field: When selected, the field specified as the association field will be both returned to Qlik Sense and included in the fields sent to the endpoint

  If the field belongs to the source data and is expected by the model, it needs to be sent to the model by enabling Send Association Field.