- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
PutFeedbackCommand
Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QConnectClient, PutFeedbackCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, PutFeedbackCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // PutFeedbackRequest
assistantId: "STRING_VALUE", // required
targetId: "STRING_VALUE", // required
targetType: "STRING_VALUE", // required
contentFeedback: { // ContentFeedbackData Union: only one key present
generativeContentFeedbackData: { // GenerativeContentFeedbackData
relevance: "STRING_VALUE", // required
},
},
};
const command = new PutFeedbackCommand(input);
const response = await client.send(command);
// { // PutFeedbackResponse
// assistantId: "STRING_VALUE", // required
// assistantArn: "STRING_VALUE", // required
// targetId: "STRING_VALUE", // required
// targetType: "STRING_VALUE", // required
// contentFeedback: { // ContentFeedbackData Union: only one key present
// generativeContentFeedbackData: { // GenerativeContentFeedbackData
// relevance: "STRING_VALUE", // required
// },
// },
// };
PutFeedbackCommand Input
See PutFeedbackCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
assistantId Required | string | undefined | The identifier of the Amazon Q in Connect assistant. |
contentFeedback Required | ContentFeedbackData | undefined | Information about the feedback provided. |
targetId Required | string | undefined | The identifier of the feedback target. |
targetType Required | TargetType | undefined | The type of the feedback target. |
PutFeedbackCommand Output
See PutFeedbackCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
assistantArn Required | string | undefined | The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. |
assistantId Required | string | undefined | The identifier of the Amazon Q in Connect assistant. |
contentFeedback Required | ContentFeedbackData | undefined | Information about the feedback provided. |
targetId Required | string | undefined | The identifier of the feedback target. |
targetType Required | TargetType | undefined | The type of the feedback target. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
ResourceNotFoundException | client | The specified resource does not exist. |
ValidationException | client | The input fails to satisfy the constraints specified by a service. |
QConnectServiceException | Base exception class for all service exceptions from QConnect service. |