QBusiness / Client / put_feedback

put_feedback#

QBusiness.Client.put_feedback(**kwargs)#

Enables your end user to to provide feedback on their Amazon Q generated chat responses.

See also: AWS API Documentation

Request Syntax

response = client.put_feedback(
    applicationId='string',
    conversationId='string',
    messageCopiedAt=datetime(2015, 1, 1),
    messageId='string',
    messageUsefulness={
        'comment': 'string',
        'reason': 'NOT_FACTUALLY_CORRECT'|'HARMFUL_OR_UNSAFE'|'INCORRECT_OR_MISSING_SOURCES'|'NOT_HELPFUL'|'FACTUALLY_CORRECT'|'COMPLETE'|'RELEVANT_SOURCES'|'HELPFUL'|'NOT_BASED_ON_DOCUMENTS'|'NOT_COMPLETE'|'NOT_CONCISE'|'OTHER',
        'submittedAt': datetime(2015, 1, 1),
        'usefulness': 'USEFUL'|'NOT_USEFUL'
    },
    userId='string'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The identifier of the application associated with the feedback.

  • conversationId (string) –

    [REQUIRED]

    The identifier of the conversation the feedback is attached to.

  • messageCopiedAt (datetime) – The timestamp for when the feedback was recorded.

  • messageId (string) –

    [REQUIRED]

    The identifier of the chat message that the feedback was given for.

  • messageUsefulness (dict) –

    The feedback usefulness value given by the user to the chat message.

    • comment (string) –

      A comment given by an end user on the usefulness of an AI-generated chat message.

    • reason (string) –

      The reason for a usefulness rating.

    • submittedAt (datetime) – [REQUIRED]

      The timestamp for when the feedback was submitted.

    • usefulness (string) – [REQUIRED]

      The usefulness value assigned by an end user to a message.

  • userId (string) –

    [REQUIRED]

    The identifier of the user giving the feedback.

Returns:

None

Exceptions

  • QBusiness.Client.exceptions.ResourceNotFoundException

  • QBusiness.Client.exceptions.InternalServerException

  • QBusiness.Client.exceptions.ThrottlingException

  • QBusiness.Client.exceptions.ValidationException

  • QBusiness.Client.exceptions.AccessDeniedException