Auto-Lookup > Amazon SageMaker

This topic shows how to create a lookup with Amazon SageMaker as the data source for the Auto-Lookup form control.

Background and Setup

Prerequisites

Good to Know

  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

  1. On the Auto-Lookup form control configuration screen, on the Configure tab, click Add Lookup.

    For information about how to open this screen, refer to Auto-Lookup form control.


    Click Add Lookup
  2. On the Select Data Source Type screen, select Amazon SageMaker.

    Select Amazon SageMaker
  3. Click Next.

Lookup Details

Specifies the basic configuration for a lookup.

Figure: Lookup Details screen

Lookup Details screen

Fields

Field NameDefinition

Access Token

Description:
Specifies the access token that connects to your data source.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Add New Add New icon

Opens this Screen:
Access Token for Amazon Web Services
Function of this Screen:
Configure an access token to connect to Amazon Web Services..

Lookup Name

Description:
Specifies the name you want to give to your lookup procedure.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
Refer to:

Configure Lookup > Request tab

Configures the Amazon SageMaker model to use to create predictions.

Figure: Configure Lookup > Request tab

Request tab

Fields

Field NameDefinition

Endpoint

Description:
Specifies the Amazon SageMaker endpoint to execute the AI model to use for predictions.
Allowed Values:
An endpoint from the list.

When you select the access token in the Amazon Web Services field, this field shows the endpoints associated with the access token.

Default Value:
None
Accepts Variables:
No
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Host Name

Description:
Specifies the host name of the target container to use for predictions.

If you select a multi-container endpoint in the Endpoint field, you can specify the container host name to invoke.

Allowed Values:
One line of text (a string) that represents a target container host name from Amazon SageMaker.
Default Value:
None
Accepts Variables:
Yes
Example:

Target Model

Description:
Specifies the name of the target model from the Amazon SageMaker endpoint to use for predictions.

This field enables when you select a multi-model endpoint in the Endpoint field.

Allowed Values:
A target model from the list.

When you select the endpoint from the Endpoint field, this field shows the target model names associated with the endpoint.

Default Value:
None
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Content Type

Description:
Specifies the format to send the request.
Allowed Values:
  • CSV
  • JSON
Default Value:
None
Accepts Variables:
No
Example:
Refer to:

Configure Request Mapping

Opens this Screen:
Configure Lookup > Request > Configure Request Mapping
To Open this Field:
  1. In the Content Type field, select one of these:
    • CSV
    • JSON
Function of this Screen:
Connects the request payload from Amazon SageMaker to the process schema.

Configure Lookup > Request > Configure Request Mapping

Connects the request payload from Amazon SageMaker to the process schema.

Figure: Configure Lookup > Request tab > Configure Request Mapping screen

Configure Request Mapping screen

Fields

Field NameDefinition

Variable / Schema Mapper / Grid View

Description:
Specifies how to connect the request data from Amazon SageMaker to your AgilePoint process schema.
Allowed Values:
  • Variable - Specifies a variable that stores the payload. The value of the process data variable must be in a valid JSON format.
  • Schema Mapper - Specifies a payload to use to connect to the AgilePoint process schema.

    Click the Map Schema button to open the Schema Mapper.

    Use this screen to connect the payload values to the AgilePoint process schema.

  • Grid View - Sends a request in specified key-value pairs.
Default Value:
Variable
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Column Name

Description:
Specifies the name of the column to use for predictions.
To Open this Field:
  1. On the Configure Request Mapping screen, select Grid View.
Allowed Values:
A column name from Amazon SageMaker.
Default Value:
None
Accepts Variables:
No
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Column Value

Description:
Specifies a value for the column in a key-value pair.
To Open this Field:
  1. On the Configure Request Mapping screen, select Grid View.
Allowed Values:
A number or a text string that can contain spaces.
Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Add Add icon

Function:
Adds a row for the Column Name and Column Value.
To Open this Field:
  1. On the Configure Request Mapping screen, select Grid View.

Delete Delete icon

Function:
Deletes the selected row.
To Open this Field:
  1. On the Configure Request Mapping screen, select Grid View.

Configure Lookup > Response tab

Specifies where to store the response from Amazon SageMaker.

Figure: Configure Lookup > Response tab

Response tab

Fields

Field NameDefinition

Endpoint

Description:
Specifies the Amazon SageMaker endpoint to execute the AI model to use for predictions.
Allowed Values:
An endpoint from the list.

When you select the access token in the Amazon Web Services field, this field shows the endpoints associated with the access token.

Default Value:
None
Accepts Variables:
No
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Host Name

Description:
Specifies the host name of the target container to use for predictions.

If you select a multi-container endpoint in the Endpoint field, you can specify the container host name to invoke.

Allowed Values:
One line of text (a string) that represents a target container host name from Amazon SageMaker.
Default Value:
None
Accepts Variables:
Yes
Example:

Target Model

Description:
Specifies the name of the target model from the Amazon SageMaker endpoint to use for predictions.

This field enables when you select a multi-model endpoint in the Endpoint field.

Allowed Values:
A target model from the list.

When you select the endpoint from the Endpoint field, this field shows the target model names associated with the endpoint.

Default Value:
None
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Map Response To App Schema / Store Response In This Variable

Description:
Specifies where to store the response from Amazon SageMaker.
Allowed Values:
  • Map Response To App SchemaSelect this option if you want to map the information from the Amazon SageMaker data model to your process schema.

    Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

    Use this screen to connect the response to the data model for your process.

  • Store Response In This VariableSelect this option if you want to store the information from Amazon SageMaker to a variable in the AgilePoint NX app.

    In the text field, specify a variable that accepts an alphanumeric string in JSON format.

Default Value:
Map Response To App Schema
Accepts Variables:
Yes
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Configure Lookup > Error Messages tab

Configures the message to show if the lookup does not return any data.

Figure: Configure Lookup > Error Messages tab

Error Messages tab

Fields

Field NameDefinition

Endpoint

Description:
Specifies the Amazon SageMaker endpoint to execute the AI model to use for predictions.
Allowed Values:
An endpoint from the list.

When you select the access token in the Amazon Web Services field, this field shows the endpoints associated with the access token.

Default Value:
None
Accepts Variables:
No
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Host Name

Description:
Specifies the host name of the target container to use for predictions.

If you select a multi-container endpoint in the Endpoint field, you can specify the container host name to invoke.

Allowed Values:
One line of text (a string) that represents a target container host name from Amazon SageMaker.
Default Value:
None
Accepts Variables:
Yes
Example:

Target Model

Description:
Specifies the name of the target model from the Amazon SageMaker endpoint to use for predictions.

This field enables when you select a multi-model endpoint in the Endpoint field.

Allowed Values:
A target model from the list.

When you select the endpoint from the Endpoint field, this field shows the target model names associated with the endpoint.

Default Value:
None
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

No Items Retrieved

Description:
Specifies the error message to show if the lookup does not return any data.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None

Lookup Failed

Description:
Specifies the message to show if the data fails to load.
Allowed Values:
More than one line of text.
Default Value:
Failed to load data.