getPersonalizedRanking method

Future<GetPersonalizedRankingResponse> getPersonalizedRanking({ required String campaignArn, required List<String> inputList, required String userId, Map<String, String>? context, String? filterArn, Map<String, String>? filterValues, })

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.

May throw InvalidInputException. May throw ResourceNotFoundException.

Parameter campaignArn : The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

Parameter inputList : 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. The maximum is 500.

Parameter userId : The user for which you want the campaign to provide a personalized ranking.

Parameter context : 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.

Parameter filterArn : 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.

Parameter filterValues : 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.

Implementation

Future<GetPersonalizedRankingResponse> getPersonalizedRanking({
  required String campaignArn,
  required List<String> inputList,
  required String userId,
  Map<String, String>? context,
  String? filterArn,
  Map<String, String>? filterValues,
}) async {
  ArgumentError.checkNotNull(campaignArn, 'campaignArn');
  _s.validateStringLength(
    'campaignArn',
    campaignArn,
    0,
    256,
    isRequired: true,
  );
  ArgumentError.checkNotNull(inputList, 'inputList');
  ArgumentError.checkNotNull(userId, 'userId');
  _s.validateStringLength(
    'userId',
    userId,
    0,
    256,
    isRequired: true,
  );
  _s.validateStringLength(
    'filterArn',
    filterArn,
    0,
    256,
  );
  final $payload = <String, dynamic>{
    'campaignArn': campaignArn,
    'inputList': inputList,
    'userId': userId,
    if (context != null) 'context': context,
    if (filterArn != null) 'filterArn': filterArn,
    if (filterValues != null) 'filterValues': filterValues,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/personalize-ranking',
    exceptionFnMap: _exceptionFns,
  );
  return GetPersonalizedRankingResponse.fromJson(response);
}