GetProfileRecommendationsRequest ¶

class GetProfileRecommendationsRequest(TypedDict, closed=True):
    domain_name: "capo_customer_profiles.types.name.name"
    """<p>The unique name of the domain.</p>"""
    profile_id: "capo_customer_profiles.types.uuid.uuid"
    """<p>The unique identifier of the profile for which to retrieve recommendations.</p>"""
    recommender_name: "capo_customer_profiles.types.name.name"
    """<p>The unique name of the recommender.</p>"""
    context: NotRequired[
        "capo_customer_profiles.types.recommender_context.RecommenderContext"
    ]
    """<p>The contextual metadata used to provide dynamic runtime information to tailor recommendations.</p>"""
    recommender_filters: NotRequired[
        "capo_customer_profiles.types.recommender_filters.RecommenderFilters"
    ]
    """<p>A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.</p>"""
    recommender_promotional_filters: NotRequired[
        "capo_customer_profiles.types.recommender_promotional_filters.RecommenderPromotionalFilters"
    ]
    """<p>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.</p>"""
    candidate_ids: NotRequired[
        "capo_customer_profiles.types.candidate_id_list.CandidateIdList"
    ]
    """<p>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.</p>"""
    max_results: NotRequired["capo_customer_profiles.types.max_size500.MaxSize500"]
    """<p>The maximum number of recommendations to return. The default value is 10.</p>"""
    metadata_config: NotRequired[
        "capo_customer_profiles.types.metadata_config.MetadataConfig"
    ]
    """<p>Configuration for including item metadata in the recommendation response. Use this to specify which metadata columns to return alongside recommended items.</p>"""
    diversity_config: NotRequired[
        "capo_customer_profiles.types.recommendation_diversity_config.RecommendationDiversityConfig"
    ]
    """<p>Runtime diversity configuration for this request. Enables diversity-aware recommendations and optionally supplies values for placeholder-based diversity caps configured on the recommender.</p>"""