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

Interface GetPersonalizedRankingRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetPersonalizedRankingRequest.Builder,GetPersonalizedRankingRequest>, PersonalizeRuntimeRequest.Builder, SdkBuilder<GetPersonalizedRankingRequest.Builder,GetPersonalizedRankingRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetPersonalizedRankingRequest
public static interface GetPersonalizedRankingRequest.Builder extends PersonalizeRuntimeRequest.Builder, SdkPojo, CopyableBuilder<GetPersonalizedRankingRequest.Builder,GetPersonalizedRankingRequest>

  • Method Details

    • campaignArn

      GetPersonalizedRankingRequest.Builder campaignArn(String campaignArn)

      The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

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

    • inputList

      GetPersonalizedRankingRequest.Builder inputList(Collection<String> inputList)

      A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

      Parameters:
      inputList - A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. 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.

    • inputList

      GetPersonalizedRankingRequest.Builder inputList(String... inputList)

      A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

      Parameters:
      inputList - A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. 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.

    • userId

      GetPersonalizedRankingRequest.Builder userId(String userId)

      The user for which you want the campaign to provide a personalized ranking.

      Parameters:
      userId - The user for which you want the campaign to provide a personalized ranking.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • context

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

      GetPersonalizedRankingRequest.Builder filterArn(String filterArn)

      The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user. For more information, see Filtering Recommendations.

      Parameters:
      filterArn - The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user. For more information, see Filtering Recommendations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filterValues

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

      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.

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

    • metadataColumns

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

      If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include in the personalized ranking. 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.

      Parameters:
      metadataColumns - If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include in the personalized ranking. 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.

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

    • overrideConfiguration

      GetPersonalizedRankingRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetPersonalizedRankingRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.