Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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.

Request Syntax


{
   "Documents": [ 
      { 
         "Body": "string",
         "GroupId": "string",
         "Id": "string",
         "OriginalScore": number,
         "Title": "string",
         "TokenizedBody": [ "string" ],
         "TokenizedTitle": [ "string" ]
      }
   ],
   "RescoreExecutionPlanId": "string",
   "SearchQuery": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Documents

The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.

Type: Array of Document objects

Array Members: Minimum number of 1 item.

Required: Yes

RescoreExecutionPlanId

The identifier of the rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]*

Required: Yes

SearchQuery

The input query from the search service.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: Yes

Response Syntax


{
   "RescoreId": "string",
   "ResultItems": [ 
      { 
         "DocumentId": "string",
         "Score": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

RescoreId

The identifier associated with the scores that Amazon Kendra Intelligent Ranking gives to the results. Amazon Kendra Intelligent Ranking rescores or re-ranks the results for the search service.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]

ResultItems

A list of result items for documents with new relevancy scores. The results are in descending order.

Type: Array of RescoreResultItem objects

Array Members: Minimum number of 1 item.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

HTTP Status Code: 400

ConflictException

A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.

HTTP Status Code: 400

InternalServerException

An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Support for help.

HTTP Status Code: 500

ResourceNotFoundException

The resource you want to use doesn't exist. Please check you have provided the correct resource and try again.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling. Please reduce the number of requests and try again.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.

HTTP Status Code: 400