Fetches the recommendations for a profile in the input Customer Profiles domain¶

Description¶

Fetches the recommendations for a profile in the input Customer Profiles domain. Fetches all the profile recommendations

Usage¶

customerprofiles_get_profile_recommendations(DomainName, ProfileId,
  RecommenderName, Context, RecommenderFilters,
  RecommenderPromotionalFilters, CandidateIds, MaxResults, MetadataConfig,
  DiversityConfig)

Arguments¶

• DomainName

[required] The unique name of the domain.

• ProfileId

[required] The unique identifier of the profile for which to retrieve recommendations.

• RecommenderName

[required] The unique name of the recommender.

• Context

The contextual metadata used to provide dynamic runtime information to tailor recommendations.

• RecommenderFilters

A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.

• RecommenderPromotionalFilters

A list of promotional filters to apply to the recommendations. Promotional filters allow you to promote specific items within a configurable subset of recommendation results.

• CandidateIds

A list of item IDs to rank for the user. Use this when you want to re-rank a specific set of items rather than getting recommendations from the full item catalog. Required for personalized-ranking use cases.

• MaxResults

The maximum number of recommendations to return. The default value is 10.

• MetadataConfig

Configuration for including item metadata in the recommendation response. Use this to specify which metadata columns to return alongside recommended items.

• DiversityConfig

Runtime diversity configuration for this request. Enables diversity-aware recommendations and optionally supplies values for placeholder-based diversity caps configured on the recommender.

Value¶

A list with the following syntax:

list(
  Recommendations = list(
    list(
      CatalogItem = list(
        Id = "string",
        Name = "string",
        Code = "string",
        Type = "string",
        Category = "string",
        Description = "string",
        AdditionalInformation = "string",
        ImageLink = "string",
        Link = "string",
        CreatedAt = as.POSIXct(
          "2015-01-01"
        ),
        UpdatedAt = as.POSIXct(
          "2015-01-01"
        ),
        Price = "string",
        Attributes = list(
          "string"
        )
      ),
      Score = 123.0
    )
  )
)

Request syntax¶

svc$get_profile_recommendations(
  DomainName = "string",
  ProfileId = "string",
  RecommenderName = "string",
  Context = list(
    "string"
  ),
  RecommenderFilters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  RecommenderPromotionalFilters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      ),
      PromotionName = "string",
      PercentPromotedItems = 123
    )
  ),
  CandidateIds = list(
    "string"
  ),
  MaxResults = 123,
  MetadataConfig = list(
    MetadataColumns = list(
      "string"
    )
  ),
  DiversityConfig = list(
    Enabled = TRUE|FALSE,
    Values = list(
      123
    )
  )
)