AWS.Tools.KendraRanking.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.KendraRanking</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.KNRK.AddKNRKResourceTagCmdlet"> <summary> Adds a specified tag to a specified rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API. If the tag already exists, the existing value is replaced with the new value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.AddKNRKResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the rescore execution plan to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.AddKNRKResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tag keys to add to a rescore execution plan. If a tag already exists, the existing value is replaced with the new value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.AddKNRKResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KendraRanking.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.AddKNRKResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.AddKNRKResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNRK.GetKNRKRescoreExecutionPlanCmdlet"> <summary> Gets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.GetKNRKRescoreExecutionPlanCmdlet.Id"> <summary> <para> <para>The identifier of the rescore execution plan that you want to get information on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.GetKNRKRescoreExecutionPlanCmdlet.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.KendraRanking.Model.DescribeRescoreExecutionPlanResponse). Specifying the name of a property of type Amazon.KendraRanking.Model.DescribeRescoreExecutionPlanResponse 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.KNRK.GetKNRKRescoreExecutionPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNRK.GetKNRKRescoreExecutionPlanListCmdlet"> <summary> Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.GetKNRKRescoreExecutionPlanListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of rescore execution plans to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.GetKNRKRescoreExecutionPlanListCmdlet.NextToken"> <summary> <para> <para>If the response is truncated, Amazon Kendra Intelligent Ranking returns a pagination token in the response. You can use this pagination token to retrieve the next set of rescore execution plans.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.GetKNRKRescoreExecutionPlanListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SummaryItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KendraRanking.Model.ListRescoreExecutionPlansResponse). Specifying the name of a property of type Amazon.KendraRanking.Model.ListRescoreExecutionPlansResponse 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="T:Amazon.PowerShell.Cmdlets.KNRK.GetKNRKResourceTagCmdlet"> <summary> Gets a list of tags associated with a specified resource. A rescore execution plan is an example of a resource that can have tags associated with it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.GetKNRKResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the rescore execution plan to get a list of tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.GetKNRKResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KendraRanking.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.KendraRanking.Model.ListTagsForResourceResponse 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.KNRK.GetKNRKResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNRK.InvokeKNRKRescoreCmdlet"> <summary> Rescores or re-ranks search results from a search service such as OpenSearch (self managed). You use the semantic search capabilities of Amazon Kendra Intelligent Ranking to improve the search service's results. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.InvokeKNRKRescoreCmdlet.Document"> <summary> <para> <para>The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.InvokeKNRKRescoreCmdlet.RescoreExecutionPlanId"> <summary> <para> <para>The identifier of the rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.InvokeKNRKRescoreCmdlet.SearchQuery"> <summary> <para> <para>The input query from the search service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.InvokeKNRKRescoreCmdlet.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.KendraRanking.Model.RescoreResponse). Specifying the name of a property of type Amazon.KendraRanking.Model.RescoreResponse 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.KNRK.InvokeKNRKRescoreCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RescoreExecutionPlanId parameter. The -PassThru parameter is deprecated, use -Select '^RescoreExecutionPlanId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.InvokeKNRKRescoreCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNRK.NewKNRKRescoreExecutionPlanCmdlet"> <summary> Creates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API. You set the number of capacity units that you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results. <para> For an example of using the <code>CreateRescoreExecutionPlan</code> API, including using the Python and Java SDKs, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/search-service-rerank.html">Semantically ranking a search service's results</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.NewKNRKRescoreExecutionPlanCmdlet.Description"> <summary> <para> <para>A description for the rescore execution plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.NewKNRKRescoreExecutionPlanCmdlet.Name"> <summary> <para> <para>A name for the rescore execution plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.NewKNRKRescoreExecutionPlanCmdlet.CapacityUnits_RescoreCapacityUnit"> <summary> <para> <para>The amount of extra capacity for your rescore execution plan.</para><para>A single extra capacity unit for a rescore execution plan provides 0.01 rescore requests per second. You can add up to 1000 extra capacity units.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.NewKNRKRescoreExecutionPlanCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs that identify or categorize your rescore execution plan. You can also use tags to help control access to the rescore execution plan. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.NewKNRKRescoreExecutionPlanCmdlet.ClientToken"> <summary> <para> <para>A token that you provide to identify the request to create a rescore execution plan. Multiple calls to the <code>CreateRescoreExecutionPlanRequest</code> API with the same client token will create only one rescore execution plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.NewKNRKRescoreExecutionPlanCmdlet.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.KendraRanking.Model.CreateRescoreExecutionPlanResponse). Specifying the name of a property of type Amazon.KendraRanking.Model.CreateRescoreExecutionPlanResponse 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.KNRK.NewKNRKRescoreExecutionPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.NewKNRKRescoreExecutionPlanCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNRK.RemoveKNRKRescoreExecutionPlanCmdlet"> <summary> Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.RemoveKNRKRescoreExecutionPlanCmdlet.Id"> <summary> <para> <para>The identifier of the rescore execution plan that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.RemoveKNRKRescoreExecutionPlanCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KendraRanking.Model.DeleteRescoreExecutionPlanResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.RemoveKNRKRescoreExecutionPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.RemoveKNRKRescoreExecutionPlanCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNRK.RemoveKNRKResourceTagCmdlet"> <summary> Removes a tag from a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> operation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.RemoveKNRKResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the rescore execution plan to remove the tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.RemoveKNRKResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of tag keys to remove from the rescore execution plan. If a tag key does not exist on the resource, it is ignored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.RemoveKNRKResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KendraRanking.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.RemoveKNRKResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.RemoveKNRKResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KNRK.UpdateKNRKRescoreExecutionPlanCmdlet"> <summary> Updates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API. You can update the number of capacity units you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.UpdateKNRKRescoreExecutionPlanCmdlet.Description"> <summary> <para> <para>A new description for the rescore execution plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.UpdateKNRKRescoreExecutionPlanCmdlet.Id"> <summary> <para> <para>The identifier of the rescore execution plan that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.UpdateKNRKRescoreExecutionPlanCmdlet.Name"> <summary> <para> <para>A new name for the rescore execution plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.UpdateKNRKRescoreExecutionPlanCmdlet.CapacityUnits_RescoreCapacityUnit"> <summary> <para> <para>The amount of extra capacity for your rescore execution plan.</para><para>A single extra capacity unit for a rescore execution plan provides 0.01 rescore requests per second. You can add up to 1000 extra capacity units.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.UpdateKNRKRescoreExecutionPlanCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KendraRanking.Model.UpdateRescoreExecutionPlanResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.UpdateKNRKRescoreExecutionPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KNRK.UpdateKNRKRescoreExecutionPlanCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |