Records user feedback on one agent interaction and publishes it to events. The feedback includes the question, the answer, whether it was positive, and, for negative feedback, its categories and a description.

When to use it

Use it to capture ratings from your users, such as a thumbs up or down in a chat interface. Pass the interaction_id that Ask an agent returned for the answer.

Required parameters

• id (path): the application worker ID of the agent.
• interaction_id (body): the ID of the interaction the feedback is about.
• question (body): the question the user asked.
• answer (body): the answer the agent gave.
• is_positive (body): whether the feedback is positive.
• negative_feedback_category_harmful (body): whether the feedback marks the answer as harmful.
• negative_feedback_category_untrue (body): whether the feedback marks the answer as untrue.
• negative_feedback_category_unhelpful (body): whether the feedback marks the answer as unhelpful.
• negative_feedback_category_other (body): whether the feedback falls in another category.
• feedback_description (body): the user's description of the feedback.

Optional body fields: agent_id.

Response

A successful call returns 204 No Content with an empty body.

Related: Ask an agent, Ask an agent and stream the answer, Get an agent