Skip to main content
Submit user feedback lets you add a feature where providers can rate generated notes and leave optional comments so Suki can improve future note quality for your integration.

How to submit user feedback

To submit feedback, call submitFeedback(_:for:onCompletion:) after a provider reviews a generated note. The API captures how well the note matched the encounter, helping Suki improve future note quality. You can use it with a rating control, such as stars or thumbs up/down, and an optional comment field. A single submission can include both quantitative feedback (a rating) and qualitative feedback (comments).

Function signature

The method takes a FeedbackSubmission, the sessionId for the session you are rating, and a completion handler. On success, the handler returns a unique feedbackId; on failure, it returns an error.

Required data structures

To submit feedback, construct a FeedbackSubmission. It combines a FeedbackEntity (what the feedback is about), a QuantitativeFeedback (the rating and its scale), and an optional comments string for free-text feedback.

Implementation example

To submit feedback, you first create the FeedbackSubmission object and then pass it to the submitFeedback method along with the sessionId. The method is asynchronous. The completion handler returns a Result containing either a success message with the unique feedbackId or an error if the submission failed.
  • Provide feedback for each entity type once per session only.
  • At present feedback submissions are only supported for the .content entity. This may be expanded in the future.
  • Submitting feedback for the same entity type a second time in the same session will be considered invalid.

Rating system

  • The maxRating must be greater than the minRating.
  • The rating must be within the inclusive range of minRating and maxRating.
  • The comments string is optional and has a maximum length of 2000 characters.
  • Configure any integer rating scale. For example, create a 1 to 5 scale by setting minRating to 1 and maxRating to 5, or a binary scale by setting the values to 0 and 1.
  • Suki recommends using a scale of 1 to 5 for ratings.

Next steps

Session status and content retrieval - overview of all retrieval workflows. Check status and retrieve content - Confirm processing is complete before collecting feedback. Clear session - Clear local session state after retrieve.
Last modified on October 16, 2026