Create Rescore Execution Plan

kendraranking_create_rescore_execution_plan

R Documentation

Creates a rescore execution plan¶

Description¶

Creates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the rescore 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.

For an example of using the create_rescore_execution_plan API, including using the Python and Java SDKs, see Semantically ranking a search service's results.

Usage¶

kendraranking_create_rescore_execution_plan(Name, Description,
  CapacityUnits, Tags, ClientToken)

Arguments¶

Name: [required] A name for the rescore execution plan.
Description: A description for the rescore execution plan.
CapacityUnits: You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For more information on the default capacity and additional capacity units, see Adjusting capacity.
Tags: 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: _ . : / = + - @.
ClientToken: A token that you provide to identify the request to create a rescore execution plan. Multiple calls to the CreateRescoreExecutionPlanRequest API with the same client token will create only one rescore execution plan.

Value¶

A list with the following syntax:

list(
  Id = "string",
  Arn = "string"
)

Request syntax¶

svc$create_rescore_execution_plan(
  Name = "string",
  Description = "string",
  CapacityUnits = list(
    RescoreCapacityUnits = 123
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  ClientToken = "string"
)