Package software.amazon.awssdk.services.personalizeruntime.model

Interface GetRecommendationsRequest.Builder

    • Method Detail

      • campaignArn

        GetRecommendationsRequest.Builder campaignArn​(String campaignArn)

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

        Parameters:
        campaignArn - The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • itemId

        GetRecommendationsRequest.Builder itemId​(String itemId)

        The item ID to provide recommendations for.

        Required for RELATED_ITEMS recipe type.

        Parameters:
        itemId - The item ID to provide recommendations for.

        Required for RELATED_ITEMS recipe type.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userId

        GetRecommendationsRequest.Builder userId​(String userId)

        The user ID to provide recommendations for.

        Required for USER_PERSONALIZATION recipe type.

        Parameters:
        userId - The user ID to provide recommendations for.

        Required for USER_PERSONALIZATION recipe type.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • numResults

        GetRecommendationsRequest.Builder numResults​(Integer numResults)

        The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

        Parameters:
        numResults - The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • context

        GetRecommendationsRequest.Builder context​(Map<String,​String> 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filterArn

        GetRecommendationsRequest.Builder filterArn​(String 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filterValues

        GetRecommendationsRequest.Builder filterValues​(Map<String,​String> 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 and user segments.

        Parameters:
        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 and user segments.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • recommenderArn

        GetRecommendationsRequest.Builder recommenderArn​(String recommenderArn)

        The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

        Parameters:
        recommenderArn - The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • promotions

        GetRecommendationsRequest.Builder promotions​(Collection<Promotion> promotions)

        The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

        Parameters:
        promotions - The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • promotions

        GetRecommendationsRequest.Builder promotions​(Promotion... promotions)

        The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

        Parameters:
        promotions - The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • promotions

        GetRecommendationsRequest.Builder promotions​(Consumer<Promotion.Builder>... promotions)

        The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

        This is a convenience method that creates an instance of the Promotion.Builder avoiding the need to create one manually via Promotion.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #promotions(List).

        Parameters:
        promotions - a consumer that will call methods on Promotion.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #promotions(java.util.Collection)

      • metadataColumns

        GetRecommendationsRequest.Builder metadataColumns​(Map<String,​? extends Collection<String>> metadataColumns)

        If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.

        For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

        Parameters:
        metadataColumns - If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.

        For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

        Returns:
        Returns a reference to this object so that method calls can be chained together.