rescore_execution_plans

Creates, updates, deletes, gets or lists a rescore_execution_plans resource.

Overview

Name	rescore_execution_plans
Type	Resource
Id	aws.kendra_ranking.rescore_execution_plans

Fields

The following fields are returned by SELECT queries:

describe_rescore_execution_plan

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the rescore execution plan. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
capacity_units	object	The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore execution plan is using the default capacity. For more information on the default capacity and additional capacity units, see Adjusting capacity.
created_at	string (date-time)	The Unix timestamp of when the rescore execution plan was created.
description	string	The description for the rescore execution plan. (pattern: <code>^\P{C}*$</code>)
error_message	string	When the Status field value is FAILED, the ErrorMessage field contains a message that explains why. (pattern: <code>^\P{C}*$</code>)
id	string	The identifier of the rescore execution plan. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]*</code>)
name	string	The name for the rescore execution plan. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_-]*</code>)
status	string	The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution plan is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why. (CREATING, UPDATING, ACTIVE, DELETING, FAILED)
updated_at	string (date-time)	The Unix timestamp of when the rescore execution plan was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_rescore_execution_plan	select	region		Gets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
create_rescore_execution_plan	insert	region		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 CreateRescoreExecutionPlan API, including using the Python and Java SDKs, see Semantically ranking a search service's results.
update_rescore_execution_plan	update	region		Updates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore 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.
delete_rescore_execution_plan	delete	region		Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
list_rescore_execution_plans	exec	region		Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
rescore	exec	region, RescoreExecutionPlanId, SearchQuery, Documents		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_rescore_execution_plan

Gets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

SELECT
arn,
capacity_units,
created_at,
description,
error_message,
id,
name,
status,
updated_at
FROM aws.kendra_ranking.rescore_execution_plans
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_rescore_execution_plan

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 CreateRescoreExecutionPlan API, including using the Python and Java SDKs, see Semantically ranking a search service's results.

INSERT INTO aws.kendra_ranking.rescore_execution_plans (
Name,
Description,
CapacityUnits,
Tags,
ClientToken,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ CapacityUnits }}',
'{{ Tags }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
arn,
id
;

Manifest

# Description fields are for documentation purposes
- name: rescore_execution_plans
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the rescore_execution_plans resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      A name for the rescore execution plan.
  - name: Description
    value: "{{ Description }}"
    description: |
      A description for the rescore execution plan.
  - name: CapacityUnits
    description: |
      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.
    value:
      RescoreCapacityUnits: {{ RescoreCapacityUnits }}
  - name: Tags
    description: |
      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: _ . : / = + - @.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      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.

UPDATE examples

update_rescore_execution_plan

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

UPDATE aws.kendra_ranking.rescore_execution_plans
SET 
Id = '{{ Id }}',
Name = '{{ Name }}',
Description = '{{ Description }}',
CapacityUnits = '{{ CapacityUnits }}'
WHERE 
region = '{{ region }}' --required;

DELETE examples

delete_rescore_execution_plan

Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

DELETE FROM aws.kendra_ranking.rescore_execution_plans
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_rescore_execution_plans

Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

EXEC aws.kendra_ranking.rescore_execution_plans.list_rescore_execution_plans 
@region='{{ region }}' --required 
@@json=
'{
"NextToken": "{{ NextToken }}", 
"MaxResults": {{ MaxResults }}
}'
;

rescore

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.

EXEC aws.kendra_ranking.rescore_execution_plans.rescore 
@region='{{ region }}' --required 
@@json=
'{
"RescoreExecutionPlanId": "{{ RescoreExecutionPlanId }}", 
"SearchQuery": "{{ SearchQuery }}", 
"Documents": "{{ Documents }}"
}'
;