We announced the upcoming end-of-support for AWS SDK for JavaScript v2.

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.PersonalizeRuntime

Inherits:

AWS.Service

Object
AWS.Service
AWS.PersonalizeRuntime

show all

Identifier:: personalizeruntime

API Version:: 2018-05-22

Defined in:: (unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Sending a Request Using PersonalizeRuntime

var personalizeruntime = new AWS.PersonalizeRuntime();
personalizeruntime.getActionRecommendations(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the PersonalizeRuntime object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var personalizeruntime = new AWS.PersonalizeRuntime({apiVersion: '2018-05-22'});

You can also set the API version globally in AWS.config.apiVersions using the personalizeruntime service identifier:

AWS.config.apiVersions = {
  personalizeruntime: '2018-05-22',
  // other service API versions
};

var personalizeruntime = new AWS.PersonalizeRuntime();

Version:

2018-05-22

Constructor Summary collapse

new AWS.PersonalizeRuntime(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

getActionRecommendations(params = {}, callback) ⇒ AWS.Request
Returns a list of recommended actions in sorted in descending order by prediction score.
getPersonalizedRanking(params = {}, callback) ⇒ AWS.Request
Re-ranks a list of recommended items for the given user.
getRecommendations(params = {}, callback) ⇒ AWS.Request
Returns a list of recommended items.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.PersonalizeRuntime(options = {}) ⇒ `Object`

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a PersonalizeRuntime object

var personalizeruntime = new AWS.PersonalizeRuntime({apiVersion: '2018-05-22'});

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.PersonalizeRuntime.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.PersonalizeRuntime.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.PersonalizeRuntime.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
useFipsEndpoint (Boolean) —
Enables FIPS compatible endpoints. Defaults to false.
useDualstackEndpoint (Boolean) —
Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

getActionRecommendations(params = {}, callback) ⇒ `AWS.Request`

Returns a list of recommended actions in sorted in descending order by prediction score. Use the GetActionRecommendations API if you have a custom campaign that deploys a solution version trained with a PERSONALIZED_ACTIONS recipe.

For more information about PERSONALIZED_ACTIONS recipes, see PERSONALIZED_ACTIONS recipes. For more information about getting action recommendations, see Getting action recommendations.

Service Reference:

GetActionRecommendations

Examples:

Calling the getActionRecommendations operation

var params = {
  campaignArn: 'STRING_VALUE',
  filterArn: 'STRING_VALUE',
  filterValues: {
    '<FilterAttributeName>': 'STRING_VALUE',
    /* '<FilterAttributeName>': ... */
  },
  numResults: 'NUMBER_VALUE',
  userId: 'STRING_VALUE'
};
personalizeruntime.getActionRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- campaignArn — (String)
  The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.
- userId — (String)
  The user ID of the user to provide action recommendations for.
- numResults — (Integer)
  The number of results to return. The default is 5. The maximum is 100.
- filterArn — (String)
  The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.
  
  When using this parameter, be sure the filter resource is ACTIVE.
- filterValues — (map<String>)
  The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
  
  For filter expressions that use an INCLUDE element to include actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude actions, you can omit the filter-values. In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.
  
  For more information, see Filtering recommendations and user segments.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - actionList — (Array<map>)
    A list of action recommendations sorted in descending order by prediction score. There can be a maximum of 100 actions in the list. For information about action scores, see How action recommendation scoring works.
    
    actionId — (String)
    The ID of the recommended action.
    
    score — (Float)
    The score of the recommended action. For information about action scores, see How action recommendation scoring works.
  - recommendationId — (String)
    The ID of the recommendation.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getPersonalizedRanking(params = {}, callback) ⇒ `AWS.Request`

Re-ranks a list of recommended items for the given user. The first item in the list is deemed the most likely item to be of interest to the user.

Note: The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING.

Service Reference:

GetPersonalizedRanking

Examples:

Calling the getPersonalizedRanking operation

var params = {
  campaignArn: 'STRING_VALUE', /* required */
  inputList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  userId: 'STRING_VALUE', /* required */
  context: {
    '<AttributeName>': 'STRING_VALUE',
    /* '<AttributeName>': ... */
  },
  filterArn: 'STRING_VALUE',
  filterValues: {
    '<FilterAttributeName>': 'STRING_VALUE',
    /* '<FilterAttributeName>': ... */
  },
  metadataColumns: {
    '<DatasetType>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<DatasetType>': ... */
  }
};
personalizeruntime.getPersonalizedRanking(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- campaignArn — (String)
  The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.
- inputList — (Array<String>)
  A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.
- userId — (String)
  The user for which you want the campaign to provide a personalized ranking.
- context — (map<String>)
  The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.
- filterArn — (String)
  The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user. For more information, see Filtering Recommendations.
- filterValues — (map<String>)
  The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
  
  For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.
  
  For more information, see Filtering Recommendations.
- metadataColumns — (map<Array<String>>)
  If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include in the personalized ranking. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.
  
  For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - personalizedRanking — (Array<map>)
    A list of items in order of most likely interest to the user. The maximum is 500.
    
    itemId — (String)
    The recommended item ID.
    
    score — (Float)
    A numeric representation of the model's certainty that the item will be the next user selection. For more information on scoring logic, see how-scores-work.
    
    promotionName — (String)
    The name of the promotion that included the predicted item.
    
    metadata — (map<String>)
    Metadata about the item from your Items dataset.
    
    reason — (Array<String>)
    If you use User-Personalization-v2, a list of reasons for why the item was included in recommendations. Possible reasons include the following:
    
    Promoted item - Indicates the item was included as part of a promotion that you applied in your recommendation request.
    
    Exploration - Indicates the item was included with exploration. With exploration, recommendations include items with less interactions data or relevance for the user. For more information about exploration, see Exploration.
    
    Popular item - Indicates the item was included as a placeholder popular item. If you use a filter, depending on how many recommendations the filter removes, Amazon Personalize might add placeholder items to meet the numResults for your recommendation request. These items are popular items, based on interactions data, that satisfy your filter criteria. They don't have a relevance score for the user.
  - recommendationId — (String)
    The ID of the recommendation.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getRecommendations(params = {}, callback) ⇒ `AWS.Request`

Returns a list of recommended items. For campaigns, the campaign's Amazon Resource Name (ARN) is required and the required user and item input depends on the recipe type used to create the solution backing the campaign as follows:

USER_PERSONALIZATION - userId required, itemId not used
RELATED_ITEMS - itemId required, userId not used

Note: Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API.

For recommenders, the recommender's ARN is required and the required item and user input depends on the use case (domain-based recipe) backing the recommender. For information on use case requirements see Choosing recommender use cases.

Service Reference:

GetRecommendations

Examples:

Calling the getRecommendations operation

var params = {
  campaignArn: 'STRING_VALUE',
  context: {
    '<AttributeName>': 'STRING_VALUE',
    /* '<AttributeName>': ... */
  },
  filterArn: 'STRING_VALUE',
  filterValues: {
    '<FilterAttributeName>': 'STRING_VALUE',
    /* '<FilterAttributeName>': ... */
  },
  itemId: 'STRING_VALUE',
  metadataColumns: {
    '<DatasetType>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<DatasetType>': ... */
  },
  numResults: 'NUMBER_VALUE',
  promotions: [
    {
      filterArn: 'STRING_VALUE',
      filterValues: {
        '<FilterAttributeName>': 'STRING_VALUE',
        /* '<FilterAttributeName>': ... */
      },
      name: 'STRING_VALUE',
      percentPromotedItems: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  recommenderArn: 'STRING_VALUE',
  userId: 'STRING_VALUE'
};
personalizeruntime.getRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- campaignArn — (String)
  The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
- itemId — (String)
  The item ID to provide recommendations for.
  
  Required for RELATED_ITEMS recipe type.
- userId — (String)
  The user ID to provide recommendations for.
  
  Required for USER_PERSONALIZATION recipe type.
- numResults — (Integer)
  The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.
- context — (map<String>)
  The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.
- filterArn — (String)
  The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.
  
  When using this parameter, be sure the filter resource is ACTIVE.
- filterValues — (map<String>)
  The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
  
  For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.
  
  For more information, see Filtering recommendations and user segments.
- recommenderArn — (String)
  The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.
- promotions — (Array<map>)
  The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.
  - name — (String)
    The name of the promotion.
  - percentPromotedItems — (Integer)
    The percentage of recommended items to apply the promotion to.
  - filterArn — (String)
    The Amazon Resource Name (ARN) of the filter used by the promotion. This filter defines the criteria for promoted items. For more information, see Promotion filters.
  - filterValues — (map<String>)
    The values to use when promoting items. For each placeholder parameter in your promotion's filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
    
    For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values. In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.
    
    For more information on creating filters, see Filtering recommendations and user segments.
- metadataColumns — (map<Array<String>>)
  If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.
  
  For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - itemList — (Array<map>)
    A list of recommendations sorted in descending order by prediction score. There can be a maximum of 500 items in the list.
    
    itemId — (String)
    The recommended item ID.
    
    score — (Float)
    A numeric representation of the model's certainty that the item will be the next user selection. For more information on scoring logic, see how-scores-work.
    
    promotionName — (String)
    The name of the promotion that included the predicted item.
    
    metadata — (map<String>)
    Metadata about the item from your Items dataset.
    
    reason — (Array<String>)
    If you use User-Personalization-v2, a list of reasons for why the item was included in recommendations. Possible reasons include the following:
    
    Promoted item - Indicates the item was included as part of a promotion that you applied in your recommendation request.
    
    Exploration - Indicates the item was included with exploration. With exploration, recommendations include items with less interactions data or relevance for the user. For more information about exploration, see Exploration.
    
    Popular item - Indicates the item was included as a placeholder popular item. If you use a filter, depending on how many recommendations the filter removes, Amazon Personalize might add placeholder items to meet the numResults for your recommendation request. These items are popular items, based on interactions data, that satisfy your filter criteria. They don't have a relevance score for the user.
  - recommendationId — (String)
    The ID of the recommendation.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.PersonalizeRuntime

Overview

Service Description

Sending a Request Using PersonalizeRuntime

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

new AWS.PersonalizeRuntime(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

getActionRecommendations(params = {}, callback) ⇒ AWS.Request

getPersonalizedRanking(params = {}, callback) ⇒ AWS.Request

getRecommendations(params = {}, callback) ⇒ AWS.Request

new AWS.PersonalizeRuntime(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

getActionRecommendations(params = {}, callback) ⇒ `AWS.Request`

getPersonalizedRanking(params = {}, callback) ⇒ `AWS.Request`

getRecommendations(params = {}, callback) ⇒ `AWS.Request`