AWS.Tools.PersonalizeRuntime.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.PersonalizeRuntime</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRActionRecommendationCmdlet"> <summary> Returns a list of recommended actions in sorted in descending order by prediction score. Use the <code>GetActionRecommendations</code> API if you have a custom campaign that deploys a solution version trained with a PERSONALIZED_ACTIONS recipe. <para> For more information about PERSONALIZED_ACTIONS recipes, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/nexts-best-action-recipes.html">PERSONALIZED_ACTIONS recipes</a>. For more information about getting action recommendations, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/get-action-recommendations.html">Getting action recommendations</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRActionRecommendationCmdlet.CampaignArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRActionRecommendationCmdlet.FilterArn"> <summary> <para> <para>The ARN of the filter to apply to the returned recommendations. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</para><para>When using this parameter, be sure the filter resource is <code>ACTIVE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRActionRecommendationCmdlet.FilterValue"> <summary> <para> <para>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. </para><para>For filter expressions that use an <code>INCLUDE</code> element to include actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an <code>EXCLUDE</code> element to exclude actions, you can omit the <code>filter-values</code>. In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.</para><para>For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRActionRecommendationCmdlet.NumResult"> <summary> <para> <para>The number of results to return. The default is 5. The maximum is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRActionRecommendationCmdlet.UserId"> <summary> <para> <para>The user ID of the user to provide action recommendations for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRActionRecommendationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PersonalizeRuntime.Model.GetActionRecommendationsResponse). Specifying the name of a property of type Amazon.PersonalizeRuntime.Model.GetActionRecommendationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRActionRecommendationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CampaignArn parameter. The -PassThru parameter is deprecated, use -Select '^CampaignArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRPersonalizedRankingCmdlet"> <summary> Re-ranks a list of recommended items for the given user. The first item in the list is deemed the most likely item to be of interest to the user. <note><para> The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRPersonalizedRankingCmdlet.CampaignArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRPersonalizedRankingCmdlet.Context"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRPersonalizedRankingCmdlet.FilterArn"> <summary> <para> <para>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 <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRPersonalizedRankingCmdlet.FilterValue"> <summary> <para> <para>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. </para><para>For filter expressions that use an <code>INCLUDE</code> element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an <code>EXCLUDE</code> element to exclude items, you can omit the <code>filter-values</code>.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.</para><para>For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRPersonalizedRankingCmdlet.InputList"> <summary> <para> <para>A list of items (by <code>itemId</code>) 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRPersonalizedRankingCmdlet.MetadataColumn"> <summary> <para> <para>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 <code>ITEMS</code> and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.</para><para> For information about enabling metadata for a campaign, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/create-campaign-return-metadata.html">Enabling metadata in recommendations for a campaign</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRPersonalizedRankingCmdlet.UserId"> <summary> <para> <para>The user for which you want the campaign to provide a personalized ranking.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRPersonalizedRankingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PersonalizedRanking'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PersonalizeRuntime.Model.GetPersonalizedRankingResponse). Specifying the name of a property of type Amazon.PersonalizeRuntime.Model.GetPersonalizedRankingResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRPersonalizedRankingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CampaignArn parameter. The -PassThru parameter is deprecated, use -Select '^CampaignArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRRecommendationCmdlet"> <summary> Returns a list of recommended items. For campaigns, the campaign's Amazon Resource Name (ARN) is required and the required user and item input depends on the recipe type used to create the solution backing the campaign as follows: <ul><li><para> USER_PERSONALIZATION - <code>userId</code> required, <code>itemId</code> not used </para></li><li><para> RELATED_ITEMS - <code>itemId</code> required, <code>userId</code> not used </para></li></ul><note><para> Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API. </para></note><para> For recommenders, the recommender's ARN is required and the required item and user input depends on the use case (domain-based recipe) backing the recommender. For information on use case requirements see <a href="https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html">Choosing recommender use cases</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRRecommendationCmdlet.CampaignArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRRecommendationCmdlet.Context"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRRecommendationCmdlet.FilterArn"> <summary> <para> <para>The ARN of the filter to apply to the returned recommendations. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</para><para>When using this parameter, be sure the filter resource is <code>ACTIVE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRRecommendationCmdlet.FilterValue"> <summary> <para> <para>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. </para><para>For filter expressions that use an <code>INCLUDE</code> element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an <code>EXCLUDE</code> element to exclude items, you can omit the <code>filter-values</code>.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.</para><para>For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRRecommendationCmdlet.ItemId"> <summary> <para> <para>The item ID to provide recommendations for.</para><para>Required for <code>RELATED_ITEMS</code> recipe type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRRecommendationCmdlet.MetadataColumn"> <summary> <para> <para>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 <code>ITEMS</code> and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.</para><para> For information about enabling metadata for a campaign, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/create-campaign-return-metadata.html">Enabling metadata in recommendations for a campaign</a>. For information about enabling metadata for a recommender, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/create-recommender-return-metadata.html">Enabling metadata in recommendations for a recommender</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRRecommendationCmdlet.NumResult"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRRecommendationCmdlet.Promotion"> <summary> <para> <para>The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRRecommendationCmdlet.RecommenderArn"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRRecommendationCmdlet.UserId"> <summary> <para> <para>The user ID to provide recommendations for.</para><para>Required for <code>USER_PERSONALIZATION</code> recipe type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRRecommendationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ItemList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PersonalizeRuntime.Model.GetRecommendationsResponse). Specifying the name of a property of type Amazon.PersonalizeRuntime.Model.GetRecommendationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PERSR.GetPERSRRecommendationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CampaignArn parameter. The -PassThru parameter is deprecated, use -Select '^CampaignArn' instead. This parameter will be removed in a future version. </summary> </member> </members> </doc> |