Request Syntax Request Parameters Response Elements Errors See Also

SubmitFeedback

Enables you to provide feedback to Amazon Kendra to improve the performance of your index.

SubmitFeedback is currently not supported in the AWS GovCloud (US-West) region.

Request Syntax


{
   "ClickFeedbackItems": [ 
      { 
         "ClickTime": number,
         "ResultId": "string"
      }
   ],
   "IndexId": "string",
   "QueryId": "string",
   "RelevanceFeedbackItems": [ 
      { 
         "RelevanceValue": "string",
         "ResultId": "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.

ClickFeedbackItems

Tells Amazon Kendra that a particular search result link was chosen by the user.

Type: Array of ClickFeedback objects

Required: No

IndexId

The identifier of the index that was queried.

Type: String

Length Constraints: Fixed length of 36.

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

Required: Yes

QueryId

The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query API.

Type: String

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

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

Required: Yes

RelevanceFeedbackItems

Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.

Type: Array of RelevanceFeedback objects

Required: No

Response Elements

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

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

InternalServerException

An issue occurred with the internal server used for your Amazon Kendra 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

ResourceUnavailableException

The resource you want to use isn't available. 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 service. Please provide the correct input and try again.

HTTP Status Code: 400