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 operation.

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

HTTP Status Code: 400

InternalServerException

HTTP Status Code: 500

ResourceNotFoundException

HTTP Status Code: 400

ResourceUnavailableException

HTTP Status Code: 400

ThrottlingException

HTTP Status Code: 400

ValidationException

HTTP Status Code: 400