getRecommendations method

Future<GetRecommendationsResponse> getRecommendations({ required String campaignArn, Map<String, String>? context, String? filterArn, Map<String, String>? filterValues, String? itemId, int? numResults, String? userId, })

Returns a list of recommended items. The required input depends on the recipe type used to create the solution backing the campaign, as follows:

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

May throw InvalidInputException. May throw ResourceNotFoundException.

Parameter campaignArn : The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

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 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.

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.

Parameter itemId : The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

Parameter numResults : The number of results to return. The default is 25. The maximum is 500.

Parameter userId : The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Implementation

Future<GetRecommendationsResponse> getRecommendations({
  required String campaignArn,
  Map<String, String>? context,
  String? filterArn,
  Map<String, String>? filterValues,
  String? itemId,
  int? numResults,
  String? userId,
}) async {
  ArgumentError.checkNotNull(campaignArn, 'campaignArn');
  _s.validateStringLength(
    'campaignArn',
    campaignArn,
    0,
    256,
    isRequired: true,
  );
  _s.validateStringLength(
    'filterArn',
    filterArn,
    0,
    256,
  );
  _s.validateStringLength(
    'itemId',
    itemId,
    0,
    256,
  );
  _s.validateNumRange(
    'numResults',
    numResults,
    0,
    1152921504606846976,
  );
  _s.validateStringLength(
    'userId',
    userId,
    0,
    256,
  );
  final $payload = <String, dynamic>{
    'campaignArn': campaignArn,
    if (context != null) 'context': context,
    if (filterArn != null) 'filterArn': filterArn,
    if (filterValues != null) 'filterValues': filterValues,
    if (itemId != null) 'itemId': itemId,
    if (numResults != null) 'numResults': numResults,
    if (userId != null) 'userId': userId,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/recommendations',
    exceptionFnMap: _exceptionFns,
  );
  return GetRecommendationsResponse.fromJson(response);
}