PutFeedback
Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
Request Syntax
POST /applications/applicationId
/conversations/conversationId
/messages/messageId
/feedback?userId=userId
HTTP/1.1
Content-type: application/json
{
"messageCopiedAt": number
,
"messageUsefulness": {
"comment": "string
",
"reason": "string
",
"submittedAt": number
,
"usefulness": "string
"
}
}
URI Request Parameters
The request uses the following URI parameters.
- applicationId
-
The identifier of the application associated with the feedback.
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]{35}
Required: Yes
- conversationId
-
The identifier of the conversation the feedback is attached to.
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]{35}
Required: Yes
- messageId
-
The identifier of the chat message that the feedback was given for.
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]{35}
Required: Yes
- userId
-
The identifier of the user giving the feedback.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
\P{C}*
Request Body
The request accepts the following data in JSON format.
- messageCopiedAt
-
The timestamp for when the feedback was recorded.
Type: Timestamp
Required: No
- messageUsefulness
-
The feedback usefulness value given by the user to the chat message.
Type: MessageUsefulnessFeedback object
Required: No
Response Syntax
HTTP/1.1 200
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 access to perform this action. Make sure you have the required permission policies and user accounts and try again.
HTTP Status Code: 403
- InternalServerException
-
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support
for help. HTTP Status Code: 500
- ResourceNotFoundException
-
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to throttling. Reduce the number of requests and try again.
HTTP Status Code: 429
- ValidationException
-
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: