MessageFeedback
One user's feedback on an assistant-generated message.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
| In webhook payloads | View fields |
In requests
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
kind | string (FEEDBACK_KIND_THUMB, FEEDBACK_KIND_SCALE) or integer (int32) (1, 2) | Required in requests | Rating representation used to interpret the feedback value. |
thumbUp | boolean | Optional | Positive when true and negative when false; used for THUMB feedback. |
rating | integer (int32) | Optional | Numeric quality rating for SCALE feedback; the scale endpoints mean poor and excellent. Minimum: 0. Maximum: 10. |
reason | string | Optional | Optional explanation for the rating. Maximum length: 1000. |
ratedAt | string (date-time) | Optional | Timestamp when feedback was submitted (server-set) |
ratedBy | string | Optional | Identifier of the user who submitted this feedback. Set by the server from the authenticated user identity; never client-supplied. Each user has one feedback entry per message. |
Values of kind
Value scale used to interpret recorded feedback.
| Value | No. | Form | Meaning |
|---|---|---|---|
FEEDBACK_KIND_THUMB | 1 | Canonical | Binary positive or negative feedback, represented by a thumbs-up or thumbs-down choice. |
FEEDBACK_KIND_SCALE | 2 | Canonical | Feedback expressed as an integer rating from 1 through 10. |
Request validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
kind | Defined enum value | true |
kind | Disallowed values | 0 |
rating | At most | 10 |
rating | At least | 0 |
reason | Maximum length | 1000 |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
kind | string (FEEDBACK_KIND_THUMB, FEEDBACK_KIND_SCALE) or integer (int32) | Required in requests | Rating representation used to interpret the feedback value. |
thumbUp | boolean | Optional | Positive when true and negative when false; used for THUMB feedback. |
rating | integer (int32) | Optional | Numeric quality rating for SCALE feedback; the scale endpoints mean poor and excellent. Minimum: -2147483648. Maximum: 2147483647. |
reason | string | Optional | Optional explanation for the rating. |
ratedAt | string (date-time) | Optional | Timestamp when feedback was submitted (server-set) |
ratedBy | string | Optional | Identifier of the user who submitted this feedback. Set by the server from the authenticated user identity; never client-supplied. Each user has one feedback entry per message. |
Values of kind
Value scale used to interpret recorded feedback.
| Value | No. | Form | Meaning |
|---|---|---|---|
FEEDBACK_KIND_THUMB | 1 | Canonical | Binary positive or negative feedback, represented by a thumbs-up or thumbs-down choice. |
FEEDBACK_KIND_SCALE | 2 | Canonical | Feedback expressed as an integer rating from 1 through 10. |
Request validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
kind | Defined enum value | true |
kind | Disallowed values | 0 |
rating | At most | 10 |
rating | At least | 0 |
reason | Maximum length | 1000 |
In webhook payloads
Webhook JSON uses protobuf field names (snake_case).
| Field | Type | Presence | Meaning |
|---|---|---|---|
kind | string (FEEDBACK_KIND_THUMB, FEEDBACK_KIND_SCALE) or integer (int32) | Required in requests | Rating representation used to interpret the feedback value. |
thumb_up | boolean | Optional | Positive when true and negative when false; used for THUMB feedback. |
rating | integer (int32) | Optional | Numeric quality rating for SCALE feedback; the scale endpoints mean poor and excellent. Minimum: -2147483648. Maximum: 2147483647. |
reason | string | Optional | Optional explanation for the rating. |
rated_at | string (date-time) | Optional | Timestamp when feedback was submitted (server-set) |
rated_by | string | Optional | Identifier of the user who submitted this feedback. Set by the server from the authenticated user identity; never client-supplied. Each user has one feedback entry per message. |
Values of kind
Value scale used to interpret recorded feedback.
| Value | No. | Form | Meaning |
|---|---|---|---|
FEEDBACK_KIND_THUMB | 1 | Canonical | Binary positive or negative feedback, represented by a thumbs-up or thumbs-down choice. |
FEEDBACK_KIND_SCALE | 2 | Canonical | Feedback expressed as an integer rating from 1 through 10. |
Request validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
kind | Defined enum value | true |
kind | Disallowed values | 0 |
rating | At most | 10 |
rating | At least | 0 |
reason | Maximum length | 1000 |
Where used
| Reference | Relationship |
|---|---|
| Append a message without generating | POST /api/v1/llm/append-message |
| Send a message to a conversation | POST /api/v1/llm/send-message |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| Withdraw your rating on a message | POST /api/v1/llm/delete-message-rating |
| Get full conversation state | POST /api/v1/llm/conversation-state |
| Rate an assistant message | POST /api/v1/llm/rate-message |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| llm.message_published | Webhook JSON uses protobuf field names (snake_case). |
| Message | Nested in model |
| Message | Nested in model |
| Message | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-message-feedback.