SearchRecommendationsRequest ¶

class SearchRecommendationsRequest(TypedDict, closed=True):
    domain_name: "capo_customer_profiles.types.name.name"
    """<p>The unique name of the domain.</p>"""
    key_name: "capo_customer_profiles.types.name.name"
    """<p>A searchable identifier of a customer profile. You can use a predefined key, such as <code>_profileId</code>, <code>_phone</code>, or <code>_email</code>, or a custom-defined key.</p>"""
    key_values: "capo_customer_profiles.types.key_values_list.KeyValuesList"
    """<p>A list of key values. Provide one value for each field of the search key.</p>"""
    recommender: "capo_customer_profiles.types.recommender.Recommender"
    """<p>The recommender used to generate the recommendations.</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>"""
    context: NotRequired[
        "capo_customer_profiles.types.recommender_context.RecommenderContext"
    ]
    """<p>The contextual metadata used to provide dynamic runtime information to tailor recommendations.</p>"""
    diversity: 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>"""
    metadata: NotRequired[
        "capo_customer_profiles.types.recommendation_metadata.RecommendationMetadata"
    ]
    """<p>Configuration for metadata to include in recommendation responses.</p>"""
    max_recommendations: NotRequired[
        "capo_customer_profiles.types.max_size500.MaxSize500"
    ]
    """<p>The maximum number of recommendations to return. The default value is 5.</p>"""