AWS.Tools.PersonalizeRuntime

4.0.0.0

AWS.Tools.PersonalizeRuntime.dll-Help.xml

<helpItems schema="maml">
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Get-PERSRPersonalizedRanking</name>
      <description>
        <para>Calls the Amazon Personalize Runtime GetPersonalizedRanking API operation.</para>
      </description>
      <verb>Get</verb>
      <noun>PERSRPersonalizedRanking</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>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.
The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Get-PERSRPersonalizedRanking</name>
        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
          <name>CampaignArn</name>
          <description>
            <para>The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>InputList</name>
          <description>
            <para>A list of items (itemId's) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        </parameter>
        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>UserId</name>
          <description>
            <para>The user for which you want the campaign to provide a personalized ranking. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Select</name>
          <description>
            <para>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. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>PassThru</name>
          <description>
            <para>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. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
        <name>CampaignArn</name>
        <description>
          <para>The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>InputList</name>
        <description>
          <para>A list of items (itemId's) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        <type>
          <name>System.String[]</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>PassThru</name>
        <description>
          <para>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. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Select</name>
        <description>
          <para>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. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>UserId</name>
        <description>
          <para>The user for which you want the campaign to provide a personalized ranking. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>Amazon.PersonalizeRuntime.Model.PredictedItem or Amazon.PersonalizeRuntime.Model.GetPersonalizedRankingResponse</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns a collection of Amazon.PersonalizeRuntime.Model.PredictedItem objects.
The service call response (type Amazon.PersonalizeRuntime.Model.GetPersonalizedRankingResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PERSRPersonalizedRanking.html&amp;tocid=Get-PERSRPersonalizedRanking</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
    </relatedLinks>
  </command>
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Get-PERSRRecommendation</name>
      <description>
        <para>Calls the Amazon Personalize Runtime GetRecommendations API operation.</para>
      </description>
      <verb>Get</verb>
      <noun>PERSRRecommendation</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Returns a list of recommended items. The required input depends on the recipe type used to create the solution backing the campaign, as follows:
 -
RELATED_ITEMS - <code>itemId</code> required, <code>userId</code> not used
 -
USER_PERSONALIZATION - <code>itemId</code> optional, <code>userId</code> required
Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Get-PERSRRecommendation</name>
        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
          <name>CampaignArn</name>
          <description>
            <para>The Amazon Resource Name (ARN) of the campaign to use for getting recommendations. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>ItemId</name>
          <description>
            <para>The item ID to provide recommendations for.
Required for <code>RELATED_ITEMS</code> recipe type. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>NumResult</name>
          <description>
            <para>The number of results to return. The default is 25. The maximum is 100. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>UserId</name>
          <description>
            <para>The user ID to provide recommendations for.
Required for <code>USER_PERSONALIZATION</code> recipe type. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Select</name>
          <description>
            <para>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. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>PassThru</name>
          <description>
            <para>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. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
        <name>CampaignArn</name>
        <description>
          <para>The Amazon Resource Name (ARN) of the campaign to use for getting recommendations. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>ItemId</name>
        <description>
          <para>The item ID to provide recommendations for.
Required for <code>RELATED_ITEMS</code> recipe type. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>NumResult</name>
        <description>
          <para>The number of results to return. The default is 25. The maximum is 100. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        <type>
          <name>System.Int32</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>PassThru</name>
        <description>
          <para>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. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Select</name>
        <description>
          <para>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. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>UserId</name>
        <description>
          <para>The user ID to provide recommendations for.
Required for <code>USER_PERSONALIZATION</code> recipe type. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>Amazon.PersonalizeRuntime.Model.PredictedItem or Amazon.PersonalizeRuntime.Model.GetRecommendationsResponse</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns a collection of Amazon.PersonalizeRuntime.Model.PredictedItem objects.
The service call response (type Amazon.PersonalizeRuntime.Model.GetRecommendationsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PERSRRecommendation.html&amp;tocid=Get-PERSRRecommendation</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
    </relatedLinks>
  </command>
</helpItems>